diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
index d362d5b9..0a360e9c 100644
--- a/assets/_mkdocstrings.css
+++ b/assets/_mkdocstrings.css
@@ -130,4 +130,9 @@ code.doc-symbol-module {
code.doc-symbol-module::after {
content: "mod";
-}
\ No newline at end of file
+}
+
+.doc-signature .autorefs {
+ color: inherit;
+ border-bottom: 1px dotted currentcolor;
+}
diff --git a/changelog/index.html b/changelog/index.html
index 30e2ba77..47af4b03 100644
--- a/changelog/index.html
+++ b/changelog/index.html
@@ -1 +1 @@
- Changelog - mkdocstrings-python Changelog All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning .
1.9.0 - 2024-03-13Compare with 1.8.0
Dependencies Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes (cd93ee3 by Timothée Mazzucotelli). Features Code Refactoring Mark all Jinja blocks as scoped (548bdad by Timothée Mazzucotelli). 1.8.0 - 2024-01-08Compare with 1.7.5
Features 1.7.5 - 2023-11-21Compare with 1.7.4
Bug Fixes Add missing translations (fallback theme) for ReadTheDocs (2fb6513 by Timothée Mazzucotelli). Issue #115 1.7.4 - 2023-11-12Compare with 1.7.3
Bug Fixes Code Refactoring Prepare for Griffe 0.37 (b5bb8a9 by Timothée Mazzucotelli). 1.7.3 - 2023-10-09Compare with 1.7.2
Bug Fixes Don't deepcopy the local config (1300d2c by Timothée Mazzucotelli). 1.7.2 - 2023-10-05Compare with 1.7.1
Bug Fixes Code Refactoring 1.7.1 - 2023-09-28Compare with 1.7.0
Bug Fixes Stop propagation of annotation to next parameter in signature template (3a760ac by Timothée Mazzucotelli). Issue #110 Code Refactoring Look into inherited members for __init__ b97d51f by Timothée Mazzucotelli). Issue #106 1.7.0 - 2023-09-14Compare with 1.6.3
Features Add option to unwrap Annotated 53db04b by Timothée Mazzucotelli). 1.6.3 - 2023-09-11Compare with 1.6.2
Bug Fixes Make load_external_modules 266f41f by Timothée Mazzucotelli). Issue #87 Never fail when trying to format code with Black (df24bbc by Timothée Mazzucotelli). Code Refactoring Wrap docstring section elements (list style) in code tags to prevent spell checker errors (1ae8dd8 by Timothée Mazzucotelli). 1.6.2 - 2023-09-05Compare with 1.6.1
Bug Fixes Don't render cross-ref spans when they're not enabled (eed51ee by Timothée Mazzucotelli). 1.6.1 - 2023-09-04Compare with 1.6.0
Bug Fixes Fix spacing for rendered named items in Yields, Receives and Returns sections (list style) (e12688e by Timothée Mazzucotelli). Fix rendering Receives sections as lists (9ff7e68 by Timothée Mazzucotelli). 1.6.0 - 2023-08-27Compare with 1.5.2
Features Add doc - signature b6c648f by Timothée Mazzucotelli). Code Refactoring Add a format_attribute 8f0ade2 by Timothée Mazzucotelli). 1.5.2 - 2023-08-25Compare with 1.5.1
Bug Fixes Regression in children template: fix condition for when members are specified (beeebff by Timothée Mazzucotelli). Issue #100 Prevent whitespace removal before highlight filter (c6f36c0 by Timothée Mazzucotelli). Code Refactoring Never show full object path in ToC entry (9aa758b by Timothée Mazzucotelli). Sync templates with insiders, remove useless lines (38b317f by Timothée Mazzucotelli). 1.5.1 - 2023-08-24Compare with 1.5.0
Code Refactoring Never show full path in separate signature since it would appear in the heading already (9e02049 by Timothée Mazzucotelli). Improve guessing whether an object is public (35eb811 by Timothée Mazzucotelli). Always sort modules alphabetically as source order wouldn't make sense (70c81ce by Timothée Mazzucotelli). Return anchors as a tuple, not a set, to preserve order (736a2b5 by Timothée Mazzucotelli). Related-to #mkdocstrings/crystal#6 1.5.0 - 2023-08-20Compare with 1.4.0
Features Add support for new Griffe docstring sections: modules, classes, and functions (methods) (d5337af by Timothée Mazzucotelli). 1.4.0 - 2023-08-18Compare with 1.3.0
Features Support new Griffe expressions (in v0.33) (9b8e1b1 by Timothée Mazzucotelli). Code Refactoring Deprecate crossref multi_crossref 4fe3d20 by Timothée Mazzucotelli). 1.3.0 - 2023-08-06Compare with 1.2.1
Dependencies Features Show parameter default values within the "list" section style too (55f08f3 by Antoine Dechaume). PR #92 , Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me 1.2.1 - 2023-07-20Compare with 1.2.0
Bug Fixes Fix members ordering when members are specified with a boolean (c69f9c3 by Timothée Mazzucotelli). Issue #89 1.2.0 - 2023-07-14Compare with 1.1.2
Features Bug Fixes Don't show None 3d8724e by Timothée Mazzucotelli). Issue #85 Show labels in deterministic order (02619a8 by Oleh Prypin). 1.1.2 - 2023-06-04Compare with 1.1.1
Code Refactoring Keep headings style consistent (CSS) (92032e5 by Timothée Mazzucotelli). 1.1.1 - 2023-06-04Compare with 1.1.0
Bug Fixes Fix mkdocs and readthedocs themes support (14f18b2 by Timothée Mazzucotelli). Code Refactoring Improve display of paragraphs in docstring sections (439f5e6 by Timothée Mazzucotelli). 1.1.0 - 2023-05-25Compare with 1.0.0
Features Support custom templates through objects' extra data (8ff2b06 by Timothée Mazzucotelli). PR #70 1.0.0 - 2023-05-11Compare with 0.10.1
Breaking changes The signature of the format_signature
class . html expression . html function . html signature . html You can see how to use the filter in this commit's changes: f686f4e4 .
We take this as an opportunity to go out of beta and bump the version to 1.0.0. This will allow users to rely on semantic versioning.
Bug Fixes Bring compatibility with insiders signature crossrefs feature (f686f4e by Timothée Mazzucotelli). 0.10.1 - 2023-05-07Compare with 0.10.0
Bug Fixes Format signatures with full-path names (685512d by Timothée Mazzucotelli). 0.10.0 - 2023-05-07Compare with 0.9.0
Features Bug Fixes Code Refactoring Match documented behavior for filtering (all members, list, none) (c7f70c3 by Timothée Mazzucotelli). Switch to an info level log for when black's not installed (f593bb0 by Faster Speeding). Return anchors as a set (e2b820c by Timothée Mazzucotelli). 0.9.0 - 2023-04-03Compare with 0.8.3
Features Bug Fixes Prevent alias resolution error when searching for anchors (a190e2c by Timothée Mazzucotelli). Issue #64 Code Refactoring Support Griffe 0.26 (075735c by Timothée Mazzucotelli). Log (debug) unresolved aliases (9164742 by Timothée Mazzucotelli). 0.8.3 - 2023-01-04Compare with 0.8.2
Code Refactoring Change "unresolved aliases" log level to DEBUG (dccb818 by Timothée Mazzucotelli). 0.8.2 - 2022-11-19Compare with 0.8.1
Bug Fixes Fix base directory used to expand globs (34cfa4b by Florian Hofer). PR #45 0.8.1 - 2022-11-19Compare with 0.8.0
Bug Fixes 0.8.0 - 2022-11-13Compare with 0.7.1
Features Code Refactoring Support Griffe 0.24 (3b9f701 by Timothée Mazzucotelli). 0.7.1 - 2022-06-12Compare with 0.7.0
Bug Fixes 0.7.0 - 2022-05-28Compare with 0.6.6
Packaging / Dependencies Depend on mkdocstrings 0.19 (b6a9a47 by Timothée Mazzucotelli). Features Bug Fixes Fix CSS class on labels (312a709 by Timothée Mazzucotelli). Fix categories rendering (6407cf4 by Timothée Mazzucotelli). Issue #14 Code Refactoring Disable show_submodules 480d0c3 by Timothée Mazzucotelli). Merge default configuration options in handler (347ce76 by Timothée Mazzucotelli). Reduce number of template debug logs (8fed314 by Timothée Mazzucotelli). Respect show_root_full_path ToC entries (hidden headings) (8f4c853 by Timothée Mazzucotelli). Bring consistency on headings style (59104c4 by Timothée Mazzucotelli). Stop using deprecated base classes (d5ea1c5 by Timothée Mazzucotelli). 0.6.6 - 2022-03-06Compare with 0.6.5
Code Refactoring Always hide self cls 7f579d1 by Timothée Mazzucotelli). Issue #7 Use pycon 6545900 by Timothée Mazzucotelli). 0.6.5 - 2022-02-24Compare with 0.6.4
Bug Fixes Don't escape signatures return annotations (ac54bfc by Timothée Mazzucotelli). Issue #6 0.6.4 - 2022-02-22Compare with 0.6.3
Bug Fixes Fix rendering of signature return annotation (b92ba3b by Timothée Mazzucotelli). Issue #4 0.6.3 - 2022-02-20Compare with 0.6.2
Bug Fixes 0.6.2 - 2022-02-17Compare with 0.6.1
Bug Fixes Catch alias resolution errors (b734dd0 by Timothée Mazzucotelli). 0.6.1 - 2022-02-17Compare with 0.6.0
Bug Fixes Don't pop from fallback config (bde32af by Timothée Mazzucotelli). Fix rendering init method source when merged into class (4a20aea by Timothée Mazzucotelli). 0.6.0 - 2022-02-13Compare with 0.5.4
Features Add option to merge __init__ 1b4d1c0 by Timothée Mazzucotelli). Support separate attribute signature (e962b88 by Timothée Mazzucotelli). Bug Fixes Restore full cross-refs paths on hover (ac11970 by Timothée Mazzucotelli). Fix rendering of labels (52919c5 by Timothée Mazzucotelli). Code Refactoring Don't add trailing parentheses in functions heading when separate signature (885696e by Timothée Mazzucotelli). Use more explicit template debug messages (f2122d7 by Timothée Mazzucotelli). 0.5.4 - 2022-02-13Compare with 0.5.3
Bug Fixes Don't load additional modules during fallback (69b8e25 by Timothée Mazzucotelli). 0.5.3 - 2022-02-08Compare with 0.5.2
Bug Fixes Allow passing null f526816 by Timothée Mazzucotelli). Issue #2 0.5.2 - 2022-02-05Compare with 0.5.1
Dependencies Require at least mkdocstrings 0.18 (7abdda4 by Timothée Mazzucotelli). 0.5.1 - 2022-02-03Compare with 0.5.0
Dependencies Depend on Griffe >= 0.11.1 (1303557 by Timothée Mazzucotelli). Code Refactoring Move handler into its own module (b787e78 by Timothée Mazzucotelli). 0.5.0 - 2022-02-03Compare with 0.4.1
Features Allow changing docstring style of an object (39240c1 by Timothée Mazzucotelli). Bug Fixes Warn if Black is not installed when formatting signature (b848277 by Timothée Mazzucotelli). Fix missing default for docstring_section_style 774988e by Timothée Mazzucotelli). Code Refactoring Change to new way of stripping paragraphs (33d4594 by Timothée Mazzucotelli). 0.4.1 - 2022-02-01Compare with 0.4.0
Bug Fixes Fix docstring admonitions rendering (a24ae2e by Timothée Mazzucotelli). 0.4.0 - 2022-02-01Compare with 0.3.0
Code Refactoring Use the new mkdocstrings_handlers 23c9023 by Timothée Mazzucotelli). 0.3.0 - 2022-01-14Compare with 0.2.0
Features Support griffe 0.10 (28061de by Timothée Mazzucotelli). Dependencies Require griffe 0.10 (cfbd7bb by Timothée Mazzucotelli). Code Refactoring Use new logger patching utility (4cdb292 by Timothée Mazzucotelli). 0.2.0 - 2021-12-28Compare with 0.1.0
Dependencies Depend on griffe >= 0.7.1 (34f7ebd by Timothée Mazzucotelli). Upgrade griffe, no upper bound (8f0aa42 by Timothée Mazzucotelli). Features Add show_signature 0f07c2e by Will Da Silva). Bug Fixes Fix templates for named docstring elements (47868a1 by Timothée Mazzucotelli). 0.1.0 - 2021-12-19Compare with first commit
Features Implement handler and add templates (dbb580a by Timothée Mazzucotelli). Bug Fixes Fix separate signature feature (da6e81c by Timothée Mazzucotelli). Fix signature template (parameters annotations) (b34ead0 by Timothée Mazzucotelli). Only show source when present (c270d68 by Timothée Mazzucotelli). Code Refactoring Return all known anchors (9bbfe14 by Timothée Mazzucotelli). Update for griffe 0.4.0 (831aabb by Timothée Mazzucotelli). GitHub
\ No newline at end of file
+ Changelog - mkdocstrings-python Changelog All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning .
1.9.0 - 2024-03-13Compare with 1.8.0
Dependencies Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes (cd93ee3 by Timothée Mazzucotelli). Features Code Refactoring Mark all Jinja blocks as scoped (548bdad by Timothée Mazzucotelli). 1.8.0 - 2024-01-08Compare with 1.7.5
Features 1.7.5 - 2023-11-21Compare with 1.7.4
Bug Fixes Add missing translations (fallback theme) for ReadTheDocs (2fb6513 by Timothée Mazzucotelli). Issue #115 1.7.4 - 2023-11-12Compare with 1.7.3
Bug Fixes Code Refactoring Prepare for Griffe 0.37 (b5bb8a9 by Timothée Mazzucotelli). 1.7.3 - 2023-10-09Compare with 1.7.2
Bug Fixes Don't deepcopy the local config (1300d2c by Timothée Mazzucotelli). 1.7.2 - 2023-10-05Compare with 1.7.1
Bug Fixes Code Refactoring 1.7.1 - 2023-09-28Compare with 1.7.0
Bug Fixes Stop propagation of annotation to next parameter in signature template (3a760ac by Timothée Mazzucotelli). Issue #110 Code Refactoring Look into inherited members for __init__ methods when merging docstrings (b97d51f by Timothée Mazzucotelli). Issue #106 1.7.0 - 2023-09-14Compare with 1.6.3
Features Add option to unwrap Annotated types (53db04b by Timothée Mazzucotelli). 1.6.3 - 2023-09-11Compare with 1.6.2
Bug Fixes Make load_external_modules a global-only option (266f41f by Timothée Mazzucotelli). Issue #87 Never fail when trying to format code with Black (df24bbc by Timothée Mazzucotelli). Code Refactoring Wrap docstring section elements (list style) in code tags to prevent spell checker errors (1ae8dd8 by Timothée Mazzucotelli). 1.6.2 - 2023-09-05Compare with 1.6.1
Bug Fixes Don't render cross-ref spans when they're not enabled (eed51ee by Timothée Mazzucotelli). 1.6.1 - 2023-09-04Compare with 1.6.0
Bug Fixes Fix spacing for rendered named items in Yields, Receives and Returns sections (list style) (e12688e by Timothée Mazzucotelli). Fix rendering Receives sections as lists (9ff7e68 by Timothée Mazzucotelli). 1.6.0 - 2023-08-27Compare with 1.5.2
Features Add doc-signature CSS class to separate signature code blocks (b6c648f by Timothée Mazzucotelli). Code Refactoring Add a format_attribute filter, preparing for cross-refs in attribute signatures (8f0ade2 by Timothée Mazzucotelli). 1.5.2 - 2023-08-25Compare with 1.5.1
Bug Fixes Regression in children template: fix condition for when members are specified (beeebff by Timothée Mazzucotelli). Issue #100 Prevent whitespace removal before highlight filter (c6f36c0 by Timothée Mazzucotelli). Code Refactoring Never show full object path in ToC entry (9aa758b by Timothée Mazzucotelli). Sync templates with insiders, remove useless lines (38b317f by Timothée Mazzucotelli). 1.5.1 - 2023-08-24Compare with 1.5.0
Code Refactoring Never show full path in separate signature since it would appear in the heading already (9e02049 by Timothée Mazzucotelli). Improve guessing whether an object is public (35eb811 by Timothée Mazzucotelli). Always sort modules alphabetically as source order wouldn't make sense (70c81ce by Timothée Mazzucotelli). Return anchors as a tuple, not a set, to preserve order (736a2b5 by Timothée Mazzucotelli). Related-to #mkdocstrings/crystal#6 1.5.0 - 2023-08-20Compare with 1.4.0
Features Add support for new Griffe docstring sections: modules, classes, and functions (methods) (d5337af by Timothée Mazzucotelli). 1.4.0 - 2023-08-18Compare with 1.3.0
Features Support new Griffe expressions (in v0.33) (9b8e1b1 by Timothée Mazzucotelli). Code Refactoring Deprecate crossref and multi_crossref filters (4fe3d20 by Timothée Mazzucotelli). 1.3.0 - 2023-08-06Compare with 1.2.1
Dependencies Features Show parameter default values within the "list" section style too (55f08f3 by Antoine Dechaume). PR #92 , Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me 1.2.1 - 2023-07-20Compare with 1.2.0
Bug Fixes Fix members ordering when members are specified with a boolean (c69f9c3 by Timothée Mazzucotelli). Issue #89 1.2.0 - 2023-07-14Compare with 1.1.2
Features Bug Fixes Don't show None as return annotation of class signatures (3d8724e by Timothée Mazzucotelli). Issue #85 Show labels in deterministic order (02619a8 by Oleh Prypin). 1.1.2 - 2023-06-04Compare with 1.1.1
Code Refactoring Keep headings style consistent (CSS) (92032e5 by Timothée Mazzucotelli). 1.1.1 - 2023-06-04Compare with 1.1.0
Bug Fixes Fix mkdocs and readthedocs themes support (14f18b2 by Timothée Mazzucotelli). Code Refactoring Improve display of paragraphs in docstring sections (439f5e6 by Timothée Mazzucotelli). 1.1.0 - 2023-05-25Compare with 1.0.0
Features Support custom templates through objects' extra data (8ff2b06 by Timothée Mazzucotelli). PR #70 1.0.0 - 2023-05-11Compare with 0.10.1
Breaking changes The signature of the format_signature filter
class.htmlexpression.htmlfunction.htmlsignature.html You can see how to use the filter in this commit's changes: f686f4e4 .
We take this as an opportunity to go out of beta and bump the version to 1.0.0. This will allow users to rely on semantic versioning.
Bug Fixes Bring compatibility with insiders signature crossrefs feature (f686f4e by Timothée Mazzucotelli). 0.10.1 - 2023-05-07Compare with 0.10.0
Bug Fixes Format signatures with full-path names (685512d by Timothée Mazzucotelli). 0.10.0 - 2023-05-07Compare with 0.9.0
Features Bug Fixes Code Refactoring Match documented behavior for filtering (all members, list, none) (c7f70c3 by Timothée Mazzucotelli). Switch to an info level log for when black's not installed (f593bb0 by Faster Speeding). Return anchors as a set (e2b820c by Timothée Mazzucotelli). 0.9.0 - 2023-04-03Compare with 0.8.3
Features Bug Fixes Prevent alias resolution error when searching for anchors (a190e2c by Timothée Mazzucotelli). Issue #64 Code Refactoring Support Griffe 0.26 (075735c by Timothée Mazzucotelli). Log (debug) unresolved aliases (9164742 by Timothée Mazzucotelli). 0.8.3 - 2023-01-04Compare with 0.8.2
Code Refactoring Change "unresolved aliases" log level to DEBUG (dccb818 by Timothée Mazzucotelli). 0.8.2 - 2022-11-19Compare with 0.8.1
Bug Fixes Fix base directory used to expand globs (34cfa4b by Florian Hofer). PR #45 0.8.1 - 2022-11-19Compare with 0.8.0
Bug Fixes 0.8.0 - 2022-11-13Compare with 0.7.1
Features Code Refactoring Support Griffe 0.24 (3b9f701 by Timothée Mazzucotelli). 0.7.1 - 2022-06-12Compare with 0.7.0
Bug Fixes 0.7.0 - 2022-05-28Compare with 0.6.6
Packaging / Dependencies Depend on mkdocstrings 0.19 (b6a9a47 by Timothée Mazzucotelli). Features Bug Fixes Fix CSS class on labels (312a709 by Timothée Mazzucotelli). Fix categories rendering (6407cf4 by Timothée Mazzucotelli). Issue #14 Code Refactoring Disable show_submodules by default (480d0c3 by Timothée Mazzucotelli). Merge default configuration options in handler (347ce76 by Timothée Mazzucotelli). Reduce number of template debug logs (8fed314 by Timothée Mazzucotelli). Respect show_root_full_path for ToC entries (hidden headings) (8f4c853 by Timothée Mazzucotelli). Bring consistency on headings style (59104c4 by Timothée Mazzucotelli). Stop using deprecated base classes (d5ea1c5 by Timothée Mazzucotelli). 0.6.6 - 2022-03-06Compare with 0.6.5
Code Refactoring Always hide self and cls parameters (7f579d1 by Timothée Mazzucotelli). Issue #7 Use pycon for examples code blocks (6545900 by Timothée Mazzucotelli). 0.6.5 - 2022-02-24Compare with 0.6.4
Bug Fixes Don't escape signatures return annotations (ac54bfc by Timothée Mazzucotelli). Issue #6 0.6.4 - 2022-02-22Compare with 0.6.3
Bug Fixes Fix rendering of signature return annotation (b92ba3b by Timothée Mazzucotelli). Issue #4 0.6.3 - 2022-02-20Compare with 0.6.2
Bug Fixes 0.6.2 - 2022-02-17Compare with 0.6.1
Bug Fixes Catch alias resolution errors (b734dd0 by Timothée Mazzucotelli). 0.6.1 - 2022-02-17Compare with 0.6.0
Bug Fixes Don't pop from fallback config (bde32af by Timothée Mazzucotelli). Fix rendering init method source when merged into class (4a20aea by Timothée Mazzucotelli). 0.6.0 - 2022-02-13Compare with 0.5.4
Features Add option to merge __init__ methods' docstrings into their classes' docstrings (1b4d1c0 by Timothée Mazzucotelli). Support separate attribute signature (e962b88 by Timothée Mazzucotelli). Bug Fixes Restore full cross-refs paths on hover (ac11970 by Timothée Mazzucotelli). Fix rendering of labels (52919c5 by Timothée Mazzucotelli). Code Refactoring Don't add trailing parentheses in functions heading when separate signature (885696e by Timothée Mazzucotelli). Use more explicit template debug messages (f2122d7 by Timothée Mazzucotelli). 0.5.4 - 2022-02-13Compare with 0.5.3
Bug Fixes Don't load additional modules during fallback (69b8e25 by Timothée Mazzucotelli). 0.5.3 - 2022-02-08Compare with 0.5.2
Bug Fixes Allow passing null as docstring style (f526816 by Timothée Mazzucotelli). Issue #2 0.5.2 - 2022-02-05Compare with 0.5.1
Dependencies Require at least mkdocstrings 0.18 (7abdda4 by Timothée Mazzucotelli). 0.5.1 - 2022-02-03Compare with 0.5.0
Dependencies Depend on Griffe >= 0.11.1 (1303557 by Timothée Mazzucotelli). Code Refactoring Move handler into its own module (b787e78 by Timothée Mazzucotelli). 0.5.0 - 2022-02-03Compare with 0.4.1
Features Allow changing docstring style of an object (39240c1 by Timothée Mazzucotelli). Bug Fixes Warn if Black is not installed when formatting signature (b848277 by Timothée Mazzucotelli). Fix missing default for docstring_section_style option (774988e by Timothée Mazzucotelli). Code Refactoring Change to new way of stripping paragraphs (33d4594 by Timothée Mazzucotelli). 0.4.1 - 2022-02-01Compare with 0.4.0
Bug Fixes Fix docstring admonitions rendering (a24ae2e by Timothée Mazzucotelli). 0.4.0 - 2022-02-01Compare with 0.3.0
Code Refactoring Use the new mkdocstrings_handlers namespace (23c9023 by Timothée Mazzucotelli). 0.3.0 - 2022-01-14Compare with 0.2.0
Features Support griffe 0.10 (28061de by Timothée Mazzucotelli). Dependencies Require griffe 0.10 (cfbd7bb by Timothée Mazzucotelli). Code Refactoring Use new logger patching utility (4cdb292 by Timothée Mazzucotelli). 0.2.0 - 2021-12-28Compare with 0.1.0
Dependencies Depend on griffe >= 0.7.1 (34f7ebd by Timothée Mazzucotelli). Upgrade griffe, no upper bound (8f0aa42 by Timothée Mazzucotelli). Features Add show_signature rendering option (0f07c2e by Will Da Silva). Bug Fixes Fix templates for named docstring elements (47868a1 by Timothée Mazzucotelli). 0.1.0 - 2021-12-19Compare with first commit
Features Implement handler and add templates (dbb580a by Timothée Mazzucotelli). Bug Fixes Fix separate signature feature (da6e81c by Timothée Mazzucotelli). Fix signature template (parameters annotations) (b34ead0 by Timothée Mazzucotelli). Only show source when present (c270d68 by Timothée Mazzucotelli). Code Refactoring Return all known anchors (9bbfe14 by Timothée Mazzucotelli). Update for griffe 0.4.0 (831aabb by Timothée Mazzucotelli). GitHub
\ No newline at end of file
diff --git a/contributing/index.html b/contributing/index.html
index 86e8f44e..99315bc6 100644
--- a/contributing/index.html
+++ b/contributing/index.html
@@ -2,14 +2,14 @@
make setup
Note
If it fails for some reason, you'll need to install uv manually.
You can install it with:
python3 -m pip install --user pipx
pipx install uv
-Now you can try running make setup uv install
You now have the dependencies installed.
Run make help
Tasks This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with make run duty TASK
The Makefile detects if a virtual environment is activated, so make
If you work in VSCode, we provide an action to configure VSCode for the project.
Development As usual:
create a new branch: git switch - c feature - or - bugfix - name edit the code and/or the documentation Before committing:
run make format run make check run make test if you updated the documentation or the project dependencies: run make docs go to http://localhost:8000 and check that everything looks good follow our commit message convention If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
Commit message convention Commit messages must follow our convention based on the Angular style or the Karma convention :
<type>[(scope)]: Subject
+Now you can try running make setup again, or simply uv install.
You now have the dependencies installed.
Run make help to see all the available actions!
Tasks This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with make run duty TASK.
The Makefile detects if a virtual environment is activated, so make will work the same with the virtualenv activated or not.
If you work in VSCode, we provide an action to configure VSCode for the project.
Development As usual:
create a new branch: git switch -c feature-or-bugfix-name edit the code and/or the documentation Before committing:
run make format to auto-format the code run make check to check everything (fix any warning) run make test to run the tests (fix any issue) if you updated the documentation or the project dependencies: run make docs go to http://localhost:8000 and check that everything looks good follow our commit message convention If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
Don't bother updating the changelog, we will take care of this.
Commit message convention Commit messages must follow our convention based on the Angular style or the Karma convention :
<type>[(scope)]: Subject
[Body]
-Subject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build chore ci deps docs feat fix perf refactor style tests If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Subject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build: About packaging, building wheels, etc.chore: About packaging or repo/files management.ci: About Continuous Integration.deps: Dependencies update.docs: About documentation.feat: New feature.fix: Bug fix.perf: About performance.refactor: Changes that are not features or bug fixes.style: A change in code style/format.tests: About tests. If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Body.
Issue #10: https://github.com/namespace/project/issues/10
Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
-These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons :
We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
Pull requests guidelines Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
# SHA is the SHA of the commit you want to fix
+These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons :. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
Pull requests guidelines Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
# SHA is the SHA of the commit you want to fix
git commit --fixup= SHA
Once all the changes are approved, you can squash your commits:
git rebase -i --autosquash main
And force-push:
git push -f
diff --git a/credits/index.html b/credits/index.html
index 74d92f13..d95b6406 100644
--- a/credits/index.html
+++ b/credits/index.html
@@ -1 +1 @@
- Credits - mkdocstrings-python
Credits These projects were used to build mkdocstrings-python . Thank you!
python uv copier - uv
Runtime dependencies Project Summary Version (accepted) Version (last resolved) License Jinja2 A very fast and expressive template engine. >= 2.11.1 3.1.3 BSD-3-Clause Markdown Python implementation of John Gruber's Markdown. >= 3.3 , < 3.6 3.5.2 BSD License MarkupSafe Safely add untrusted strings to HTML/XML markup. >= 1.1 2.1.5 BSD-3-Clause PyYAML YAML parser and emitter for Python >= 5.1 6.0.1 MIT click Composable command line interface toolkit >= 7.0 8.1.7 BSD-3-Clause colorama Cross-platform colored terminal text. >= 0.4 0.4.6 BSD License ghp - import Copy your docs directly to the gh-pages branch. >= 1.0 2.1.0 Apache Software License griffe Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. >= 0.40 0.42.0.1.2.0 ISC importlib_metadata Read metadata from Python packages >= 4.6 7.0.2 Apache Software License mergedeep A deep merge function for 🐍. >= 1.3.4 1.3.4 MIT License mkdocs Project documentation with Markdown. >= 1.5 , >= 1.4 1.5.3 BSD-2-Clause mkdocs - autorefs Automatically link across pages in MkDocs. >= 0.3.1 1.0.1 ISC mkdocstrings Automatic documentation from sources, for MkDocs. >= 0.23 , >= 0.20 0.24.1 ISC packaging Core utilities for Python packages >= 20.5 24.0 Apache Software License + BSD License pathspec Utility library for gitignore style pattern matching of file paths. >= 0.9.0 , >= 0.11.1 0.12.1 Mozilla Public License 2.0 (MPL 2.0) platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". >= 2.2.0 4.2.0 MIT pymdown - extensions Extension pack for Python Markdown. >= 6.3 10.7.1 MIT python - dateutil Extensions to the standard Python datetime module >= 2.8.1 2.9.0 . post0 BSD License + Apache Software License pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >= 0.1 0.1 MIT License six Python 2 and 3 compatibility utilities >= 1.5 1.16.0 MIT typing_extensions Backported and Experimental Type Hints for Python 3.8+ >= 4.1 4.10.0 Python Software Foundation License watchdog Filesystem events monitoring >= 2.0 4.0.0 Apache-2.0 zipp Backport of pathlib-compatible object wrapper for zip files >= 0.5 3.18.0 MIT License
Development dependencies Project Summary Version (accepted) Version (last resolved) License Babel Internationalization utilities ~= 2.10 2.14.0 BSD-3-Clause GitPython GitPython is a Python library used to interact with Git repositories 3.1.42 BSD-3-Clause Jinja2 A very fast and expressive template engine. >= 2.11.1 3.1.3 BSD-3-Clause Markdown Python implementation of John Gruber's Markdown. >= 3.3 , < 3.6 3.5.2 BSD License MarkupSafe Safely add untrusted strings to HTML/XML markup. >= 1.1 2.1.5 BSD-3-Clause PyYAML YAML parser and emitter for Python >= 5.1 6.0.1 MIT Pygments Pygments is a syntax highlighting package written in Python. >= 2.13.0 , < 3.0.0 2.17.2 BSD-2-Clause SecretStorage Python bindings to FreeDesktop.org Secret Service API >= 3.2 3.3.3 BSD 3-Clause License ansimarkup Produce colored terminal text with an xml-like markup ~= 1.4 1.5.0 Revised BSD License appdirs A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir". >= 1.4 1.4.4 MIT black The uncompromising code formatter. >= 23.9 24.2.0 MIT blacken - docs Run Black on Python code blocks in documentation files. >= 1.16 1.16.0 MIT build A simple, correct Python build frontend >= 1.0 1.1.1 MIT License certifi Python package for providing Mozilla's CA Bundle. >= 2017.4.17 2024.2.2 MPL-2.0 cffi Foreign Function Interface for Python calling C code. >= 1.12 1.16.0 MIT charset - normalizer The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. >= 2 , < 4 3.3.2 MIT click Composable command line interface toolkit >= 7.0 8.1.7 BSD-3-Clause colorama Cross-platform colored terminal text. >= 0.4 0.4.6 BSD License coverage Code coverage measurement for Python >= 5.2.1 7.4.3 Apache-2.0 cryptography cryptography is a package which provides cryptographic recipes and primitives to Python developers. >= 2.0 42.0.5 Apache-2.0 OR BSD-3-Clause csscompressor A python port of YUI CSS Compressor >= 0.9.5 0.9.5 BSD docutils Docutils -- Python Documentation Utilities >= 0.13.1 0.20.1 public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) dparse A parser for Python dependency files >= 0.6.2 0.6.3 MIT license duty A simple task runner. >= 0.10 1.2.0 ISC execnet execnet: rapid multi-Python deployment >= 1.1 2.0.2 MIT failprint Run a command, print its output only if it fails. >= 0.11 , != 1.0.0 1.0.2 ISC ghp - import Copy your docs directly to the gh-pages branch. >= 1.0 2.1.0 Apache Software License git - changelog Automatic Changelog generator using Jinja2 templates. >= 2.3 2.4.0 ISC gitdb Git Object Database >= 4.0.1 , < 5 4.0.11 BSD License htmlmin2 An HTML Minifier >= 0.1.13 0.1.13 BSD idna Internationalized Domain Names in Applications (IDNA) >= 2.5 , < 4 3.6 BSD License importlib_metadata Read metadata from Python packages >= 4.6 7.0.2 Apache Software License iniconfig brain-dead simple config-ini parsing 2.0.0 MIT jaraco . classes Utility functions for Python class constructs 3.3.1 MIT License jeepney Low-level, pure Python DBus protocol wrapper. >= 0.4.2 0.8.0 MIT License jsmin JavaScript minifier. >= 3.0.1 3.0.1 MIT License keyring Store and access your passwords safely. >= 15.1 24.3.1 MIT License markdown - callouts Markdown extension: a classier syntax for admonitions >= 0.3 0.4.0 MIT markdown - exec Utilities to execute code blocks in Markdown files. >= 1.7 1.7.0.1.0.1 ISC markdown - it - py Python port of markdown-it. Markdown parsing, done right! >= 2.2.0 3.0.0 MIT License mdurl Markdown URL utilities ~= 0.1 0.1.2 MIT License mergedeep A deep merge function for 🐍. >= 1.3.4 1.3.4 MIT License mkdocs Project documentation with Markdown. >= 1.5 , >= 1.4 1.5.3 BSD-2-Clause mkdocs - autorefs Automatically link across pages in MkDocs. >= 0.3.1 1.0.1 ISC mkdocs - coverage MkDocs plugin to integrate your coverage HTML report into your site. >= 1.0 1.0.0 ISC mkdocs - gen - files MkDocs plugin to programmatically generate documentation pages during the build >= 0.5 0.5.0 MIT mkdocs - git - committers - plugin - 2 An MkDocs plugin to create a list of contributors on the page. The git-committers plugin will seed the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date >= 1.2 2.3.0 MIT mkdocs - literate - nav MkDocs plugin to specify the navigation in Markdown instead of YAML >= 0.6 0.6.1 MIT mkdocs - material Documentation that simply works >= 9.4 9.5.13 + insiders .4.53.1 MIT mkdocs - material - extensions Extension pack for Python Markdown and MkDocs Material. ~= 1.3 1.3.1 MIT mkdocs - minify - plugin An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk >= 0.7 0.8.0 MIT mkdocstrings Automatic documentation from sources, for MkDocs. >= 0.23 , >= 0.20 0.24.1 ISC more - itertools More routines for operating on iterables, beyond itertools 10.2.0 MIT License mypy Optional static typing for Python >= 1.5 1.9.0 MIT mypy - extensions Type system extensions for programs checked with the mypy type checker. >= 0.4.3 1.0.0 MIT License nh3 Python bindings to the ammonia HTML sanitization library. >= 0.2.14 0.2.15 MIT packaging Core utilities for Python packages >= 20.5 24.0 Apache Software License + BSD License paginate Divides large result sets into pages for easier browsing ~= 0.5 0.5.6 MIT pathspec Utility library for gitignore style pattern matching of file paths. >= 0.9.0 , >= 0.11.1 0.12.1 Mozilla Public License 2.0 (MPL 2.0) pkginfo Query metadata from sdists / bdists / installed packages. >= 1.8.1 1.10.0 MIT platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". >= 2.2.0 4.2.0 MIT pluggy plugin and hook calling mechanisms for python >= 1.4 , < 2.0 1.4.0 MIT ptyprocess Run a subprocess in a pseudo terminal ~= 0.6 0.7.0 ISC License (ISCL) pycparser C parser in Python 2.21 BSD pymdown - extensions Extension pack for Python Markdown. >= 6.3 10.7.1 MIT pyproject_hooks Wrappers to call pyproject.toml-based build backend hooks. 1.0.0 MIT License pytest pytest: simple powerful testing with Python >= 7.4 8.1.1 MIT pytest - cov Pytest plugin for measuring coverage. >= 4.1 4.1.0 MIT pytest - randomly Pytest plugin to randomly order tests and control random.seed. >= 3.15 3.15.0 MIT pytest - xdist pytest xdist plugin for distributed testing, most importantly across multiple CPUs >= 3.3 3.5.0 MIT python - dateutil Extensions to the standard Python datetime module >= 2.8.1 2.9.0 . post0 BSD License + Apache Software License pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >= 0.1 0.1 MIT License readme_renderer readme_renderer is a library for rendering readme descriptions for Warehouse >= 35.0 43.0 Apache License, Version 2.0 regex Alternative regular expression module, to replace re. >= 2022.4 2023.12.25 Apache Software License requests Python HTTP for Humans. 2.31.0 Apache 2.0 requests - toolbelt A utility belt for advanced users of python-requests >= 0.8.0 , != 0.9.0 1.0.0 Apache 2.0 rfc3986 Validating URI References per RFC 3986 >= 1.4.0 2.0.0 Apache 2.0 rich Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal >= 12.0.0 13.7.1 MIT ruamel . yaml ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order >= 0.17.21 0.18.6 MIT license ruamel . yaml . clib C version of reader, parser and emitter for ruamel.yaml derived from libyaml >= 0.2.7 0.2.8 MIT ruff An extremely fast Python linter and code formatter, written in Rust. >= 0.0 0.3.2 MIT safety Checks installed dependencies for known vulnerabilities and licenses. >= 2.3 2.3.4 MIT license semver Python helper for Semantic Versioning (https://semver.org ) >= 2.13 3.0.2 BSD setuptools Easily download, build, install, upgrade, and uninstall Python packages >= 19.3 69.2.0 MIT License six Python 2 and 3 compatibility utilities >= 1.5 1.16.0 MIT smmap A pure Python implementation of a sliding window memory map manager >= 3.0.1 , < 6 5.0.1 BSD twine Collection of utilities for publishing packages on PyPI >= 5.0 5.0.0 Apache Software License types - Markdown Typing stubs for Markdown >= 3.5 3.5.0.20240311 Apache-2.0 license types - PyYAML Typing stubs for PyYAML >= 6.0 6.0.12.20240311 Apache-2.0 license typing_extensions Backported and Experimental Type Hints for Python 3.8+ >= 4.1 4.10.0 Python Software Foundation License urllib3 HTTP library with thread-safe connection pooling, file post, and more. >= 1.26.0 2.2.1 MIT License watchdog Filesystem events monitoring >= 2.0 4.0.0 Apache-2.0 zipp Backport of pathlib-compatible object wrapper for zip files >= 0.5 3.18.0 MIT License
More credits from the author
GitHub
\ No newline at end of file
+ Credits - mkdocstrings-python
Credits These projects were used to build mkdocstrings-python . Thank you!
Python | uv | copier-uv
Runtime dependencies Project Summary Version (accepted) Version (last resolved) License Jinja2 A very fast and expressive template engine. >=2.11.13.1.3BSD-3-Clause Markdown Python implementation of John Gruber's Markdown. >=3.3, <3.63.5.2BSD License MarkupSafe Safely add untrusted strings to HTML/XML markup. >=1.12.1.5BSD-3-Clause PyYAML YAML parser and emitter for Python >=5.16.0.1MIT click Composable command line interface toolkit >=7.08.1.7BSD-3-Clause colorama Cross-platform colored terminal text. >=0.40.4.6BSD License ghp-import Copy your docs directly to the gh-pages branch. >=1.02.1.0Apache Software License griffe Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. >=0.400.42.0.1.2.0ISC importlib_metadata Read metadata from Python packages >=4.67.0.2Apache Software License mergedeep A deep merge function for 🐍. >=1.3.41.3.4MIT License mkdocs Project documentation with Markdown. >=1.5, >=1.41.5.3BSD-2-Clause mkdocs-autorefs Automatically link across pages in MkDocs. >=0.3.11.0.1ISC mkdocstrings Automatic documentation from sources, for MkDocs. >=0.23, >=0.200.24.1ISC packaging Core utilities for Python packages >=20.524.0Apache Software License + BSD License pathspec Utility library for gitignore style pattern matching of file paths. >=0.9.0, >=0.11.10.12.1Mozilla Public License 2.0 (MPL 2.0) platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". >=2.2.04.2.0MIT pymdown-extensions Extension pack for Python Markdown. >=6.310.7.1MIT python-dateutil Extensions to the standard Python datetime module >=2.8.12.9.0.post0BSD License + Apache Software License pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >=0.10.1MIT License six Python 2 and 3 compatibility utilities >=1.51.16.0MIT typing_extensions Backported and Experimental Type Hints for Python 3.8+ >=4.14.10.0Python Software Foundation License watchdog Filesystem events monitoring >=2.04.0.0Apache-2.0 zipp Backport of pathlib-compatible object wrapper for zip files >=0.53.18.0MIT License
Development dependencies Project Summary Version (accepted) Version (last resolved) License Babel Internationalization utilities ~=2.102.14.0BSD-3-Clause GitPython GitPython is a Python library used to interact with Git repositories 3.1.42BSD-3-Clause Jinja2 A very fast and expressive template engine. >=2.11.13.1.3BSD-3-Clause Markdown Python implementation of John Gruber's Markdown. >=3.3, <3.63.5.2BSD License MarkupSafe Safely add untrusted strings to HTML/XML markup. >=1.12.1.5BSD-3-Clause PyYAML YAML parser and emitter for Python >=5.16.0.1MIT Pygments Pygments is a syntax highlighting package written in Python. >=2.13.0, <3.0.02.17.2BSD-2-Clause SecretStorage Python bindings to FreeDesktop.org Secret Service API >=3.23.3.3BSD 3-Clause License ansimarkup Produce colored terminal text with an xml-like markup ~=1.41.5.0Revised BSD License appdirs A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir". >=1.41.4.4MIT black The uncompromising code formatter. >=23.924.2.0MIT blacken-docs Run Black on Python code blocks in documentation files. >=1.161.16.0MIT build A simple, correct Python build frontend >=1.01.1.1MIT License certifi Python package for providing Mozilla's CA Bundle. >=2017.4.172024.2.2MPL-2.0 cffi Foreign Function Interface for Python calling C code. >=1.121.16.0MIT charset-normalizer The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet. >=2, <43.3.2MIT click Composable command line interface toolkit >=7.08.1.7BSD-3-Clause colorama Cross-platform colored terminal text. >=0.40.4.6BSD License coverage Code coverage measurement for Python >=5.2.17.4.3Apache-2.0 cryptography cryptography is a package which provides cryptographic recipes and primitives to Python developers. >=2.042.0.5Apache-2.0 OR BSD-3-Clause csscompressor A python port of YUI CSS Compressor >=0.9.50.9.5BSD docutils Docutils -- Python Documentation Utilities >=0.13.10.20.1public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) dparse A parser for Python dependency files >=0.6.20.6.3MIT license duty A simple task runner. >=0.101.2.0ISC execnet execnet: rapid multi-Python deployment >=1.12.0.2MIT failprint Run a command, print its output only if it fails. >=0.11, !=1.0.01.0.2ISC ghp-import Copy your docs directly to the gh-pages branch. >=1.02.1.0Apache Software License git-changelog Automatic Changelog generator using Jinja2 templates. >=2.32.4.0ISC gitdb Git Object Database >=4.0.1, <54.0.11BSD License htmlmin2 An HTML Minifier >=0.1.130.1.13BSD idna Internationalized Domain Names in Applications (IDNA) >=2.5, <43.6BSD License importlib_metadata Read metadata from Python packages >=4.67.0.2Apache Software License iniconfig brain-dead simple config-ini parsing 2.0.0MIT jaraco.classes Utility functions for Python class constructs 3.3.1MIT License jeepney Low-level, pure Python DBus protocol wrapper. >=0.4.20.8.0MIT License jsmin JavaScript minifier. >=3.0.13.0.1MIT License keyring Store and access your passwords safely. >=15.124.3.1MIT License markdown-callouts Markdown extension: a classier syntax for admonitions >=0.30.4.0MIT markdown-exec Utilities to execute code blocks in Markdown files. >=1.71.7.0.1.0.1ISC markdown-it-py Python port of markdown-it. Markdown parsing, done right! >=2.2.03.0.0MIT License mdurl Markdown URL utilities ~=0.10.1.2MIT License mergedeep A deep merge function for 🐍. >=1.3.41.3.4MIT License mkdocs Project documentation with Markdown. >=1.5, >=1.41.5.3BSD-2-Clause mkdocs-autorefs Automatically link across pages in MkDocs. >=0.3.11.0.1ISC mkdocs-coverage MkDocs plugin to integrate your coverage HTML report into your site. >=1.01.0.0ISC mkdocs-gen-files MkDocs plugin to programmatically generate documentation pages during the build >=0.50.5.0MIT mkdocs-git-committers-plugin-2 An MkDocs plugin to create a list of contributors on the page. The git-committers plugin will seed the template context with a list of GitHub or GitLab committers and other useful GIT info such as last modified date >=1.22.3.0MIT mkdocs-literate-nav MkDocs plugin to specify the navigation in Markdown instead of YAML >=0.60.6.1MIT mkdocs-material Documentation that simply works >=9.49.5.13+insiders.4.53.1MIT mkdocs-material-extensions Extension pack for Python Markdown and MkDocs Material. ~=1.31.3.1MIT mkdocs-minify-plugin An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk >=0.70.8.0MIT mkdocstrings Automatic documentation from sources, for MkDocs. >=0.23, >=0.200.24.1ISC more-itertools More routines for operating on iterables, beyond itertools 10.2.0MIT License mypy Optional static typing for Python >=1.51.9.0MIT mypy-extensions Type system extensions for programs checked with the mypy type checker. >=0.4.31.0.0MIT License nh3 Python bindings to the ammonia HTML sanitization library. >=0.2.140.2.15MIT packaging Core utilities for Python packages >=20.524.0Apache Software License + BSD License paginate Divides large result sets into pages for easier browsing ~=0.50.5.6MIT pathspec Utility library for gitignore style pattern matching of file paths. >=0.9.0, >=0.11.10.12.1Mozilla Public License 2.0 (MPL 2.0) pkginfo Query metadata from sdists / bdists / installed packages. >=1.8.11.10.0MIT platformdirs A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir". >=2.2.04.2.0MIT pluggy plugin and hook calling mechanisms for python >=1.4, <2.01.4.0MIT ptyprocess Run a subprocess in a pseudo terminal ~=0.60.7.0ISC License (ISCL) pycparser C parser in Python 2.21BSD pymdown-extensions Extension pack for Python Markdown. >=6.310.7.1MIT pyproject_hooks Wrappers to call pyproject.toml-based build backend hooks. 1.0.0MIT License pytest pytest: simple powerful testing with Python >=7.48.1.1MIT pytest-cov Pytest plugin for measuring coverage. >=4.14.1.0MIT pytest-randomly Pytest plugin to randomly order tests and control random.seed. >=3.153.15.0MIT pytest-xdist pytest xdist plugin for distributed testing, most importantly across multiple CPUs >=3.33.5.0MIT python-dateutil Extensions to the standard Python datetime module >=2.8.12.9.0.post0BSD License + Apache Software License pyyaml_env_tag A custom YAML tag for referencing environment variables in YAML files. >=0.10.1MIT License readme_renderer readme_renderer is a library for rendering readme descriptions for Warehouse >=35.043.0Apache License, Version 2.0 regex Alternative regular expression module, to replace re. >=2022.42023.12.25Apache Software License requests Python HTTP for Humans. 2.31.0Apache 2.0 requests-toolbelt A utility belt for advanced users of python-requests >=0.8.0, !=0.9.01.0.0Apache 2.0 rfc3986 Validating URI References per RFC 3986 >=1.4.02.0.0Apache 2.0 rich Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal >=12.0.013.7.1MIT ruamel.yaml ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order >=0.17.210.18.6MIT license ruamel.yaml.clib C version of reader, parser and emitter for ruamel.yaml derived from libyaml >=0.2.70.2.8MIT ruff An extremely fast Python linter and code formatter, written in Rust. >=0.00.3.2MIT safety Checks installed dependencies for known vulnerabilities and licenses. >=2.32.3.4MIT license semver Python helper for Semantic Versioning (https://semver.org ) >=2.133.0.2BSD setuptools Easily download, build, install, upgrade, and uninstall Python packages >=19.369.2.0MIT License six Python 2 and 3 compatibility utilities >=1.51.16.0MIT smmap A pure Python implementation of a sliding window memory map manager >=3.0.1, <65.0.1BSD twine Collection of utilities for publishing packages on PyPI >=5.05.0.0Apache Software License types-Markdown Typing stubs for Markdown >=3.53.5.0.20240311Apache-2.0 license types-PyYAML Typing stubs for PyYAML >=6.06.0.12.20240311Apache-2.0 license typing_extensions Backported and Experimental Type Hints for Python 3.8+ >=4.14.10.0Python Software Foundation License urllib3 HTTP library with thread-safe connection pooling, file post, and more. >=1.26.02.2.1MIT License watchdog Filesystem events monitoring >=2.04.0.0Apache-2.0 zipp Backport of pathlib-compatible object wrapper for zip files >=0.53.18.0MIT License
More credits from the author
GitHub
\ No newline at end of file
diff --git a/css/mkdocstrings.css b/css/mkdocstrings.css
index 727a614c..03c39d33 100644
--- a/css/mkdocstrings.css
+++ b/css/mkdocstrings.css
@@ -18,10 +18,10 @@ a.autorefs-external::after {
height: 1em;
width: 1em;
- background-color: var(--md-typeset-a-color);
+ background-color: currentColor;
}
a.external:hover::after,
a.autorefs-external:hover::after {
background-color: var(--md-accent-fg-color);
-}
\ No newline at end of file
+}
diff --git a/index.html b/index.html
index 3d874306..bdd6c83a 100644
--- a/index.html
+++ b/index.html
@@ -10,4 +10,4 @@
dependencies = [
"mkdocstrings-python" ,
]
-Preview
Features Data collection from source code : collection of the object-tree and the docstrings is done thanks to Griffe .
Support for type annotations: Griffe collects your type annotations and mkdocstrings uses them to display parameter types or return types. It is even able to automatically add cross-references to other objects from your API, from the standard library or third-party libraries! See how to load inventories to enable it.
Recursive documentation of Python objects: just use the module dotted-path as an identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc.
Support for documented attributes: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in __init__
Multiple docstring-styles support: common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. See Griffe's documentation on docstrings support.
Admonition support in Google docstrings: blocks like Note : Warning : admonition equivalent. We do not support nested admonitions in docstrings!
Every object has a TOC entry: we render a heading for each object, meaning MkDocs picks them into the Table of Contents, which is nicely displayed by the Material theme. Thanks to mkdocstrings cross-reference ability, you can reference other objects within your docstrings, with the classic Markdown syntax: [ this object ][ package . module . object ] [ package . module . object ][]
Source code display: mkdocstrings can add a collapsible div containing the highlighted source code of the Python object.
GitHub 