We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enable versioning of the docs with mike, as detailed here: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/, which can also include a dev version of the docs.
dev
Has been done with the pipeline, however:
mkdocs-material>=8.2.4
mkdocstrings
Griffe
Edit: The python-legacy handler can be used with mkdocstrings so the behaviour doesn't change.
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Enable versioning of the docs with mike, as detailed here: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/, which can also include a
dev
version of the docs.Has been done with the pipeline, however:
mkdocs-material>=8.2.4
must be used.mkdocstrings
with theGriffe
python handler should be used.Note that some return docstrings may need fixing as it handles multiple returns slightly better than before (e.g. Tuples etc).This version ofmkdocstrings
cannot yet 'hide' the hidden functions. So either:Wait for that to be enabled.Fill in docstrings for hidden functions.Do anyway and accept that some of the reference won't be complete.Edit: The python-legacy handler can be used with
mkdocstrings
so the behaviour doesn't change.The text was updated successfully, but these errors were encountered: