diff --git a/.copier-answers.yml b/.copier-answers.yml
index c720007f..0c51afe2 100644
--- a/.copier-answers.yml
+++ b/.copier-answers.yml
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier
-_commit: 0.16.6
+_commit: 1.1.3
_src_path: gh:pawamoy/copier-pdm.git
author_email: pawamoy@pm.me
author_fullname: TimothΓ©e Mazzucotelli
@@ -9,8 +9,10 @@ copyright_holder: TimothΓ©e Mazzucotelli
copyright_holder_email: pawamoy@pm.me
copyright_license: ISC License
insiders: true
+insiders_repository_name: mkdocstrings
project_description: Automatic documentation from sources, for MkDocs.
project_name: mkdocstrings
+public_release: true
python_package_command_line_name: ''
python_package_distribution_name: mkdocstrings
python_package_import_name: mkdocstrings
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 149c6ce0..6ed84b16 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,36 +1,61 @@
---
name: Bug report
-about: Create a report to help us improve
-title: ''
+about: Create a bug report to help us improve.
+title: "bug: "
labels: unconfirmed
-assignees: ''
-
+assignees: [pawamoy]
---
-**Please open an issue on [Griffe](https://github.com/mkdocstrings/griffe/issues) (new Python handler)
-or [pytkdocs](https://github.com/mkdocstrings/pytkdocs/issues) (legacy Python handler) instead
-if this is related to Python docstrings parsing or the collection of Python objects!**
+### Description of the bug
+
+
+### To Reproduce
+
+
+```
+WRITE MRE / INSTRUCTIONS HERE
+```
+
+### Full traceback
+
+
+Full traceback
+
+```python
+PASTE TRACEBACK HERE
+```
-**Describe the bug**
-A clear and concise description of what the bug is.
+
-
-
If you sponsor publicly, you're automatically added here with a link to
your profile and avatar to show your support for *mkdocstrings*.
diff --git a/docs/recipes.md b/docs/recipes.md
index c33130f0..8ea849fc 100644
--- a/docs/recipes.md
+++ b/docs/recipes.md
@@ -17,15 +17,15 @@ Let say you have a project called `project`.
This project has a lot of source files, or modules,
which live in the `src` folder:
-```
-π repo
-βββ΄π src
- βββ΄π project
- βββ΄π lorem
- βββ΄π ipsum
- βββ΄π dolor
- βββ΄π sit
- βββ΄π amet
+```tree
+repo/
+ src/
+ project/
+ lorem
+ ipsum
+ dolor
+ sit
+ amet
```
Without an automatic process, you will have to manually
@@ -49,10 +49,10 @@ and configure it like so:
```yaml title="mkdocs.yml"
plugins:
-- search # (1)
+- search # (1)!
- gen-files:
scripts:
- - docs/gen_ref_pages.py # (2)
+ - scripts/gen_ref_pages.py # (2)!
- mkdocstrings
```
@@ -60,76 +60,91 @@ plugins:
2. The magic happens here, see below how it works.
mkdocs-gen-files is able to run Python scripts at build time.
-The Python script that we will execute lives in the docs folder,
+The Python script that we will execute lives in a scripts folder,
and is named `gen_ref_pages.py`, like "generate code reference pages".
-```python title="docs/gen_ref_pages.py"
+```tree
+repo/
+ docs/
+ index.md
+ scripts/
+ gen_ref_pages.py
+ src/
+ project/
+ mkdocs.yml
+```
+
+```python title="scripts/gen_ref_pages.py"
"""Generate the code reference pages."""
from pathlib import Path
import mkdocs_gen_files
-for path in sorted(Path("src").rglob("*.py")): # (1)
- module_path = path.relative_to("src").with_suffix("") # (2)
- doc_path = path.relative_to("src").with_suffix(".md") # (3)
- full_doc_path = Path("reference", doc_path) # (4)
+src = Path(__file__).parent.parent / "src" # (1)!
+
+for path in sorted(src.rglob("*.py")): # (2)!
+ module_path = path.relative_to(src).with_suffix("") # (3)!
+ doc_path = path.relative_to(src).with_suffix(".md") # (4)!
+ full_doc_path = Path("reference", doc_path) # (5)!
parts = list(module_path.parts)
- if parts[-1] == "__init__": # (5)
+ if parts[-1] == "__init__": # (6)!
parts = parts[:-1]
elif parts[-1] == "__main__":
continue
- with mkdocs_gen_files.open(full_doc_path, "w") as fd: # (6)
- identifier = ".".join(parts) # (7)
- print("::: " + identifier, file=fd) # (8)
+ with mkdocs_gen_files.open(full_doc_path, "w") as fd: # (7)!
+ identifier = ".".join(parts) # (8)!
+ print("::: " + identifier, file=fd) # (9)!
- mkdocs_gen_files.set_edit_path(full_doc_path, path) # (9)
+ mkdocs_gen_files.set_edit_path(full_doc_path, path) # (10)!
```
-1. Here we recursively list all `.py` files, but you can adapt the code to list
+1. It's important to build a path relative to the script itself,
+ to make it possible to build the docs with MkDocs'
+ [`-f` option](https://www.mkdocs.org/user-guide/cli/#mkdocs-build).
+2. Here we recursively list all `.py` files, but you can adapt the code to list
files with other extensions of course, supporting other languages than Python.
-2. The module path will look like `project/lorem`.
+3. The module path will look like `project/lorem`.
It will be used to build the *mkdocstrings* autodoc identifier.
-3. This is the relative path to the Markdown page.
-4. This is the absolute path to the Markdown page. Here we put all reference pages
- into a `reference` folder.
-5. This part is only relevant for Python modules. We skip `__main__` modules and
+4. This is the partial path of the Markdown page for the module.
+5. This is the full path of the Markdown page within the docs.
+ Here we put all reference pages into a `reference` folder.
+6. This part is only relevant for Python modules. We skip `__main__` modules and
remove `__init__` from the module parts as it's implicit during imports.
-6. Magic! Add the file to MkDocs pages, without actually writing it in the docs folder.
-7. Build the autodoc identifier. Here we document Python modules, so the identifier
+7. Magic! Add the file to MkDocs pages, without actually writing it in the docs folder.
+8. Build the autodoc identifier. Here we document Python modules, so the identifier
is a dot-separated path, like `project.lorem`.
-8. Actually write to the magic file.
-9. We can even set the `edit_uri` on the pages.
+9. Actually write to the magic file.
+10. We can even set the `edit_uri` on the pages.
> NOTE:
> It is important to look out for correct edit page behaviour when using generated pages.
> For example, if we have `edit_uri` set to `blob/master/docs/` and the following
> file structure:
>
-> ```
-> π repo
-> ββ π mkdocs.yml
-> β
-> ββ π docs
-> β βββ΄π index.md
-> β βββ΄π gen_ref_pages.py
-> β
-> βββ΄π src
-> βββ΄π project
-> βββ΄π lorem.py
-> βββ΄π ipsum.py
-> βββ΄π dolor.py
-> βββ΄π sit.py
-> βββ΄π amet.py
+> ```tree
+> repo/
+> mkdocs.yml
+> docs/
+> index.md
+> scripts/
+> gen_ref_pages.py
+> src/
+> project/
+> lorem.py
+> ipsum.py
+> dolor.py
+> sit.py
+> amet.py
> ```
>
> Then we will have to change our `set_edit_path` call to:
>
> ```python
-> mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path) # (1)
+> mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path) # (1)!
> ```
>
> 1. Path can be used to traverse the structure in any way you may need, but
@@ -180,7 +195,7 @@ plugins:
- search
- gen-files:
scripts:
- - docs/gen_ref_pages.py
+ - scripts/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings
@@ -188,7 +203,7 @@ plugins:
Then, the previous script is updated like so:
-```python title="docs/gen_ref_pages.py" hl_lines="7 21 29 30"
+```python title="scripts/gen_ref_pages.py" hl_lines="7 23 31 32"
"""Generate the code reference pages and navigation."""
from pathlib import Path
@@ -197,9 +212,11 @@ import mkdocs_gen_files
nav = mkdocs_gen_files.Nav()
-for path in sorted(Path("src").rglob("*.py")):
- module_path = path.relative_to("src").with_suffix("")
- doc_path = path.relative_to("src").with_suffix(".md")
+src = Path(__file__).parent.parent / "src"
+
+for path in sorted(src.rglob("*.py")):
+ module_path = path.relative_to(src).with_suffix("")
+ doc_path = path.relative_to(src).with_suffix(".md")
full_doc_path = Path("reference", doc_path)
parts = tuple(module_path.parts)
@@ -209,7 +226,7 @@ for path in sorted(Path("src").rglob("*.py")):
elif parts[-1] == "__main__":
continue
- nav[parts] = doc_path.as_posix() # (1)
+ nav[parts] = doc_path.as_posix() # (1)!
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
ident = ".".join(parts)
@@ -217,8 +234,8 @@ for path in sorted(Path("src").rglob("*.py")):
mkdocs_gen_files.set_edit_path(full_doc_path, path)
-with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file: # (2)
- nav_file.writelines(nav.build_literate_nav()) # (3)
+with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file: # (2)!
+ nav_file.writelines(nav.build_literate_nav()) # (3)!
```
1. Progressively build the navigation object.
@@ -232,7 +249,7 @@ and replace it with a single line!
nav:
# rest of the navigation...
# defer to gen-files + literate-nav
-- Code Reference: reference/ # (1)
+- Code Reference: reference/ # (1)!
# rest of the navigation...
```
@@ -259,7 +276,7 @@ Well, this is possible thanks to a third plugin:
Update the script like this:
-```python title="docs/gen_ref_pages.py" hl_lines="18 19"
+```python title="scripts/gen_ref_pages.py" hl_lines="20 21"
"""Generate the code reference pages and navigation."""
from pathlib import Path
@@ -268,9 +285,11 @@ import mkdocs_gen_files
nav = mkdocs_gen_files.Nav()
-for path in sorted(Path("src").rglob("*.py")):
- module_path = path.relative_to("src").with_suffix("")
- doc_path = path.relative_to("src").with_suffix(".md")
+src = Path(__file__).parent.parent / "src"
+
+for path in sorted(src.rglob("*.py")):
+ module_path = path.relative_to(src).with_suffix("")
+ doc_path = path.relative_to(src).with_suffix(".md")
full_doc_path = Path("reference", doc_path)
parts = tuple(module_path.parts)
@@ -301,7 +320,7 @@ plugins:
- search
- gen-files:
scripts:
- - docs/gen_ref_pages.py
+ - scripts/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
diff --git a/docs/usage/handlers.md b/docs/usage/handlers.md
index d2c25420..bd7e5823 100644
--- a/docs/usage/handlers.md
+++ b/docs/usage/handlers.md
@@ -7,6 +7,7 @@ A handler is what makes it possible to collect and render documentation for a pa
- Crystal
- Python
- Python (Legacy)
+- Shell
## About the Python handlers
diff --git a/docs/usage/index.md b/docs/usage/index.md
index 7599f9f1..1348b9cc 100644
--- a/docs/usage/index.md
+++ b/docs/usage/index.md
@@ -108,7 +108,7 @@ The above is equivalent to:
- `default_handler`: The handler that is used by default when no handler is specified.
- `custom_templates`: The path to a directory containing custom templates.
- The path is relative to the current working directory.
+ The path is relative to the MkDocs configuration file.
See [Theming](theming.md).
- `handlers`: The handlers' global configuration.
- `enable_inventory`: Whether to enable inventory file generation.
diff --git a/docs/usage/theming.md b/docs/usage/theming.md
index 73b7e0b3..b5d6f7b3 100644
--- a/docs/usage/theming.md
+++ b/docs/usage/theming.md
@@ -17,9 +17,9 @@ so you can tweak the look and feel with extra CSS rules.
### Templates
-To use custom templates and override the theme ones,
-specify the relative path to your templates directory
-with the `custom_templates` global configuration option:
+To use custom templates and override the theme ones, specify the relative path from your
+configuration file to your templates directory with the `custom_templates` global
+configuration option:
```yaml title="mkdocs.yml"
plugins:
@@ -82,7 +82,7 @@ Since each handler provides its own set of templates, with their own CSS classes
we cannot list them all here. See the documentation about CSS classes for:
- the Crystal handler: https://mkdocstrings.github.io/crystal/styling.html#custom-styles
-- the Python handler: https://mkdocstrings.github.io/python/customization/#css-classes
+- the Python handler: https://mkdocstrings.github.io/python/usage/customization/#css-classes
### Syntax highlighting
diff --git a/duties.py b/duties.py
index 644b2ffb..43ae357a 100644
--- a/duties.py
+++ b/duties.py
@@ -4,21 +4,18 @@
import os
import sys
+from contextlib import contextmanager
+from importlib.metadata import version as pkgversion
from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Iterator
from duty import duty
-from duty.callables import black, blacken_docs, coverage, lazy, mkdocs, mypy, pytest, ruff, safety
-
-if sys.version_info < (3, 8):
- from importlib_metadata import version as pkgversion
-else:
- from importlib.metadata import version as pkgversion
-
+from duty.callables import black, coverage, lazy, mkdocs, mypy, pytest, ruff, safety
if TYPE_CHECKING:
from duty.context import Context
+
PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts"))
PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS)
PY_SRC = " ".join(PY_SRC_LIST)
@@ -35,32 +32,16 @@ def pyprefix(title: str) -> str: # noqa: D103
return title
-def merge(d1: Any, d2: Any) -> Any: # noqa: D103
- basic_types = (int, float, str, bool, complex)
- if isinstance(d1, dict) and isinstance(d2, dict):
- for key, value in d2.items():
- if key in d1:
- if isinstance(d1[key], basic_types):
- d1[key] = value
- else:
- d1[key] = merge(d1[key], value)
- else:
- d1[key] = value
- return d1
- if isinstance(d1, list) and isinstance(d2, list):
- return d1 + d2
- return d2
-
-
-def mkdocs_config() -> str: # noqa: D103
- import mergedeep
-
- # force YAML loader to merge arrays
- mergedeep.merge = merge
-
+@contextmanager
+def material_insiders() -> Iterator[bool]: # noqa: D103
if "+insiders" in pkgversion("mkdocs-material"):
- return "mkdocs.insiders.yml"
- return "mkdocs.yml"
+ os.environ["MATERIAL_INSIDERS"] = "true"
+ try:
+ yield True
+ finally:
+ os.environ.pop("MATERIAL_INSIDERS")
+ else:
+ yield False
@duty
@@ -70,23 +51,9 @@ def changelog(ctx: Context) -> None:
Parameters:
ctx: The context instance (passed automatically).
"""
- from git_changelog.cli import build_and_render
+ from git_changelog.cli import main as git_changelog
- git_changelog = lazy(build_and_render, name="git_changelog")
- ctx.run(
- git_changelog(
- repository=".",
- output="CHANGELOG.md",
- convention="angular",
- template="keepachangelog",
- parse_trailers=True,
- parse_refs=False,
- sections=["build", "deps", "feat", "fix", "refactor"],
- bump_latest=True,
- in_place=True,
- ),
- title="Updating changelog",
- )
+ ctx.run(git_changelog, args=[[]], title="Updating changelog")
@duty(pre=["check_quality", "check_types", "check_docs", "check_dependencies", "check-api"])
@@ -142,12 +109,12 @@ def check_docs(ctx: Context) -> None:
"""
Path("htmlcov").mkdir(parents=True, exist_ok=True)
Path("htmlcov/index.html").touch(exist_ok=True)
- config = mkdocs_config()
- ctx.run(
- mkdocs.build(strict=True, config_file=config, verbose=True),
- title=pyprefix("Building documentation"),
- command=f"mkdocs build -vsf {config}",
- )
+ with material_insiders():
+ ctx.run(
+ mkdocs.build(strict=True, verbose=True),
+ title=pyprefix("Building documentation"),
+ command="mkdocs build -vs",
+ )
@duty
@@ -212,11 +179,12 @@ def docs(ctx: Context, host: str = "127.0.0.1", port: int = 8000) -> None:
host: The host to serve the docs from.
port: The port to serve the docs on.
"""
- ctx.run(
- mkdocs.serve(dev_addr=f"{host}:{port}", config_file=mkdocs_config()),
- title="Serving documentation",
- capture=False,
- )
+ with material_insiders():
+ ctx.run(
+ mkdocs.serve(dev_addr=f"{host}:{port}"),
+ title="Serving documentation",
+ capture=False,
+ )
@duty
@@ -227,22 +195,26 @@ def docs_deploy(ctx: Context) -> None:
ctx: The context instance (passed automatically).
"""
os.environ["DEPLOY"] = "true"
- config_file = mkdocs_config()
- if config_file == "mkdocs.yml":
- ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
- origin = ctx.run("git config --get remote.origin.url", silent=True)
- if "pawamoy-insiders/mkdocstrings" in origin:
- ctx.run("git remote add org-pages git@github.com:mkdocstrings/mkdocstrings.github.io", silent=True, nofail=True)
- ctx.run(
- mkdocs.gh_deploy(config_file=config_file, remote_name="org-pages", force=True),
- title="Deploying documentation",
- )
- else:
- ctx.run(
- lambda: False,
- title="Not deploying docs from public repository (do that from insiders instead!)",
- nofail=True,
- )
+ with material_insiders() as insiders:
+ if not insiders:
+ ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
+ origin = ctx.run("git config --get remote.origin.url", silent=True)
+ if "pawamoy-insiders/mkdocstrings" in origin:
+ ctx.run(
+ "git remote add org-pages git@github.com:mkdocstrings/mkdocstrings.github.io",
+ silent=True,
+ nofail=True,
+ )
+ ctx.run(
+ mkdocs.gh_deploy(remote_name="upstream", force=True),
+ title="Deploying documentation",
+ )
+ else:
+ ctx.run(
+ lambda: False,
+ title="Not deploying docs from public repository (do that from insiders instead!)",
+ nofail=True,
+ )
@duty
@@ -257,11 +229,6 @@ def format(ctx: Context) -> None:
title="Auto-fixing code",
)
ctx.run(black.run(*PY_SRC_LIST, config="config/black.toml"), title="Formatting code")
- ctx.run(
- blacken_docs.run(*PY_SRC_LIST, "docs", exts=["py", "md"], line_length=120),
- title="Formatting docs",
- nofail=True,
- )
@duty(post=["docs-deploy"])
@@ -314,3 +281,28 @@ def test(ctx: Context, match: str = "") -> None:
title=pyprefix("Running tests"),
command=f"pytest -c config/pytest.ini -n auto -k{match!r} --color=yes tests",
)
+
+
+@duty
+def vscode(ctx: Context) -> None:
+ """Configure VSCode.
+
+ This task will overwrite the following files,
+ so make sure to back them up:
+
+ - `.vscode/launch.json`
+ - `.vscode/settings.json`
+ - `.vscode/tasks.json`
+
+ Parameters:
+ ctx: The context instance (passed automatically).
+ """
+
+ def update_config(filename: str) -> None:
+ source_file = Path("config", "vscode", filename)
+ target_file = Path(".vscode", filename)
+ target_file.parent.mkdir(exist_ok=True)
+ target_file.write_text(source_file.read_text())
+
+ for filename in ("launch.json", "settings.json", "tasks.json"):
+ ctx.run(update_config, args=[filename], title=f"Update .vscode/{filename}")
diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml
deleted file mode 100644
index a93edcc3..00000000
--- a/mkdocs.insiders.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-INHERIT: mkdocs.yml
-
-# waiting for https://github.com/squidfunk/mkdocs-material/issues/5446
-# plugins:
-# - typeset
diff --git a/mkdocs.yml b/mkdocs.yml
index fdd6898b..37a98cf4 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -27,6 +27,7 @@ nav:
- Crystal: https://mkdocstrings.github.io/crystal/
- Python: https://mkdocstrings.github.io/python/
- Python (Legacy): https://mkdocstrings.github.io/python-legacy/
+ - Shell: https://mkdocstrings.github.io/shell/
- Guides:
- Recipes: recipes.md
- Troubleshooting: troubleshooting.md
@@ -95,12 +96,13 @@ markdown_extensions:
- admonition
- callouts
- footnotes
-- pymdownx.emoji:
- emoji_index: !!python/name:materialx.emoji.twemoji
- emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.details
+- pymdownx.emoji:
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.magiclink
- pymdownx.snippets:
+ base_path: [!relative $config_dir]
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
@@ -110,6 +112,7 @@ markdown_extensions:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
+- pymdownx.tilde
- toc:
permalink: "Β€"
@@ -120,7 +123,7 @@ plugins:
scripts:
- scripts/gen_ref_nav.py
- literate-nav:
- nav_file: SUMMARY.txt
+ nav_file: SUMMARY.md
- coverage
- mkdocstrings:
handlers:
@@ -129,11 +132,14 @@ plugins:
- https://docs.python.org/3/objects.inv
- https://installer.readthedocs.io/en/stable/objects.inv # demonstration purpose in the docs
- https://mkdocstrings.github.io/autorefs/objects.inv
+ paths: [src]
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
+ filters: ["!^_"]
heading_level: 1
+ inherited_members: true
merge_init_into_class: true
separate_signature: true
show_root_heading: true
@@ -152,6 +158,10 @@ plugins:
handlers/overview.md: usage/handlers.md
- minify:
minify_html: !ENV [DEPLOY, false]
+- group:
+ enabled: !ENV [MATERIAL_INSIDERS, false]
+ plugins:
+ - typeset
extra:
social:
diff --git a/pyproject.toml b/pyproject.toml
index 78af6bff..1be96db8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -29,11 +29,13 @@ classifiers = [
"Typing :: Typed",
]
dependencies = [
+ "click>=7.0",
"Jinja2>=2.11.1",
"Markdown>=3.3",
"MarkupSafe>=1.1",
- "mkdocs>=1.2",
+ "mkdocs>=1.4",
"mkdocs-autorefs>=0.3.1",
+ "platformdirs>=2.2.0",
"pymdown-extensions>=6.3",
"importlib-metadata>=4.6; python_version < '3.10'",
"typing-extensions>=4.1; python_version < '3.10'",
@@ -72,44 +74,43 @@ duty = ["duty>=0.10"]
ci-quality = ["mkdocstrings[duty,docs,quality,typing,security]"]
ci-tests = ["mkdocstrings[duty,docs,tests]"]
docs = [
- "black>=23.1",
- "markdown-callouts>=0.2",
- "markdown-exec>=0.5",
+ "black>=23.9",
+ "markdown-callouts>=0.3",
+ "markdown-exec>=1.7",
"mkdocs>=1.5",
- "mkdocs-coverage>=0.2",
- "mkdocs-gen-files>=0.3",
- "mkdocs-git-committers-plugin-2>=1.1",
- "mkdocs-literate-nav>=0.4",
- "mkdocs-material>=7.3",
- "mkdocs-minify-plugin>=0.6.4",
- "mkdocs-redirects>=1.2.0",
- "mkdocstrings-python>=0.5.1",
- "toml>=0.10",
+ "mkdocs-coverage>=1.0",
+ "mkdocs-gen-files>=0.5",
+ "mkdocs-git-committers-plugin-2>=1.2",
+ "mkdocs-literate-nav>=0.6",
+ "mkdocs-material>=9.4",
+ "mkdocs-minify-plugin>=0.7",
+ "mkdocs-redirects>=1.2",
+ "mkdocstrings-python>=1.7",
+ "tomli>=2.0; python_version < '3.11'",
]
maintain = [
- "black>=23.1",
- "blacken-docs>=1.13",
- "git-changelog>=1.0",
+ "black>=23.9",
+ "blacken-docs>=1.16",
+ "git-changelog>=2.3",
]
quality = [
- "ruff>=0.0.246",
+ "ruff>=0.0",
]
tests = [
"docutils",
"pygments>=2.10", # python 3.6
- "pytest>=6.2",
- "pytest-cov>=3.0",
- "pytest-randomly>=3.10",
- "pytest-xdist>=2.4",
+ "pytest>=7.4",
+ "pytest-cov>=4.1",
+ "pytest-randomly>=3.15",
+ "pytest-xdist>=3.3",
"sphinx",
]
typing = [
- "mypy>=0.911",
- "types-docutils",
- "types-markdown>=3.3",
+ "mypy>=1.5",
+ "types-docutils>=0.20,",
+ "types-markdown>=3.5",
"types-pyyaml>=6.0",
- "types-toml>=0.10",
]
security = [
- "safety>=2",
+ "safety>=2.3",
]
diff --git a/scripts/gen_credits.py b/scripts/gen_credits.py
index bc01c0bd..bf35f0da 100644
--- a/scripts/gen_credits.py
+++ b/scripts/gen_credits.py
@@ -2,27 +2,31 @@
from __future__ import annotations
+import os
import re
import sys
+from importlib.metadata import PackageNotFoundError, metadata
from itertools import chain
from pathlib import Path
from textwrap import dedent
from typing import Mapping, cast
-import toml
from jinja2 import StrictUndefined
from jinja2.sandbox import SandboxedEnvironment
-if sys.version_info < (3, 8):
- from importlib_metadata import PackageNotFoundError, metadata
+# TODO: Remove once support for Python 3.10 is dropped.
+if sys.version_info >= (3, 11):
+ import tomllib
else:
- from importlib.metadata import PackageNotFoundError, metadata
+ import tomli as tomllib
-project_dir = Path(".")
-pyproject = toml.load(project_dir / "pyproject.toml")
+project_dir = Path(os.getenv("MKDOCS_CONFIG_DIR", "."))
+with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
+ pyproject = tomllib.load(pyproject_file)
project = pyproject["project"]
pdm = pyproject["tool"]["pdm"]
-lock_data = toml.load(project_dir / "pdm.lock")
+with project_dir.joinpath("pdm.lock").open("rb") as lock_file:
+ lock_data = tomllib.load(lock_file)
lock_pkgs = {pkg["name"].lower(): pkg for pkg in lock_data["package"]}
project_name = project["name"]
regex = re.compile(r"(?P[\w.-]+)(?P.*)$")
@@ -35,7 +39,7 @@ def _get_license(pkg_name: str) -> str:
return "?"
license_name = cast(dict, data).get("License", "").strip()
multiple_lines = bool(license_name.count("\n"))
- # TODO: remove author logic once all my packages licenses are fixed
+ # TODO: Remove author logic once all my packages licenses are fixed.
author = ""
if multiple_lines or not license_name or license_name == "UNKNOWN":
for header, value in cast(dict, data).items():
diff --git a/scripts/gen_ref_nav.py b/scripts/gen_ref_nav.py
index 249530b1..9c041ede 100644
--- a/scripts/gen_ref_nav.py
+++ b/scripts/gen_ref_nav.py
@@ -7,9 +7,11 @@
nav = mkdocs_gen_files.Nav()
mod_symbol = '