Skip to content
New issue

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 docs versioning with mike #330

Open
ajstewart opened this issue Mar 2, 2022 · 0 comments
Open

Enable docs versioning with mike #330

ajstewart opened this issue Mar 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ajstewart
Copy link
Collaborator

ajstewart commented Mar 2, 2022

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.
  • Later version of mkdocstrings with the Griffe 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 of mkdocstrings 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.

@ajstewart ajstewart added the documentation Improvements or additions to documentation label Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant