Skip to content

Commit 0d015fe

Browse files
committed
refactor: Stop using mkdocs-material-insiders
1 parent a9a3bc9 commit 0d015fe

2 files changed

Lines changed: 11 additions & 35 deletions

File tree

project/duties.py.jinja

Lines changed: 10 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,12 @@ from __future__ import annotations
55
import os
66
import re
77
import sys
8-
from contextlib import contextmanager
9-
from importlib.metadata import version as pkgversion
108
from pathlib import Path
119
from typing import TYPE_CHECKING
1210

1311
from duty import duty, tools
1412

1513
if TYPE_CHECKING:
16-
from collections.abc import Iterator
17-
1814
from duty.context import Context
1915

2016

@@ -36,18 +32,6 @@ def pyprefix(title: str) -> str:
3632
return title
3733

3834

39-
@contextmanager
40-
def material_insiders() -> Iterator[bool]:
41-
if "+insiders" in pkgversion("mkdocs-material"):
42-
os.environ["MATERIAL_INSIDERS"] = "true"
43-
try:
44-
yield True
45-
finally:
46-
os.environ.pop("MATERIAL_INSIDERS")
47-
else:
48-
yield False
49-
50-
5135
def _get_changelog_version() -> str:
5236
changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
5337
with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
@@ -84,11 +68,10 @@ def check_docs(ctx: Context) -> None:
8468
"""Check if the documentation builds correctly."""
8569
Path("htmlcov").mkdir(parents=True, exist_ok=True)
8670
Path("htmlcov/index.html").touch(exist_ok=True)
87-
with material_insiders():
88-
ctx.run(
89-
tools.mkdocs.build(strict=True, verbose=True),
90-
title=pyprefix("Building documentation"),
91-
)
71+
ctx.run(
72+
tools.mkdocs.build(strict=True, verbose=True),
73+
title=pyprefix("Building documentation"),
74+
)
9275

9376

9477
@duty(nofail=PY_VERSION == PY_DEV)
@@ -119,22 +102,18 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
119102
host: The host to serve the docs from.
120103
port: The port to serve the docs on.
121104
"""
122-
with material_insiders():
123-
ctx.run(
124-
tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
125-
title="Serving documentation",
126-
capture=False,
127-
)
105+
ctx.run(
106+
tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
107+
title="Serving documentation",
108+
capture=False,
109+
)
128110

129111

130112
@duty
131113
def docs_deploy(ctx: Context) -> None:
132114
"""Deploy the documentation to GitHub pages."""
133115
os.environ["DEPLOY"] = "true"
134-
with material_insiders() as insiders:
135-
if not insiders:
136-
ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
137-
ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
116+
ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
138117

139118

140119
@duty

project/mkdocs.yml.jinja

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,7 @@ plugins:
145145
type: timeago
146146
- minify:
147147
minify_html: !ENV [DEPLOY, false]
148-
- group:
149-
enabled: !ENV [MATERIAL_INSIDERS, false]
150-
plugins:
151-
- typeset
148+
- typeset
152149

153150
extra:
154151
social:

0 commit comments

Comments
 (0)