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.

Sign up for GitHub

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

Jump to bottom

Improve mkdocstrings configuration #85

Merged
merged 3 commits into from
Nov 10, 2023
Merged

Improve mkdocstrings configuration #85

merged 3 commits into from
Nov 10, 2023

Commits on Nov 3, 2023

  1. docs: replace deprecated materialx for emoji markdown extension 

    The emoji extension is updated to avoid using deprecated extension.
See new extension syntax here:
https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji
    @cofri
    cofri committed Nov 3, 2023
    Configuration menu
    Copy the full SHA
    4d8c7a8 View commit details
    Browse the repository at this point in the history

  2. docs: improve docs for better rendering of API 

    The latest mkdocs version is based on a new Python handler for doc rendering.
This requires some updates and improvements.

- merge_init_into_class: the docstrings of class and of __init__ are merged
  into a unique docstring. It avoids the __init__() signature in the API doc
  and in the table of contents on the right side of the web page.
- docstring_section_style (spacy): better rendering of the table of parameters
- separate_signature: signature of function is separated from the title. It
  makes things clearer and with a better rendering.
    @cofri
    cofri committed Nov 3, 2023
    Configuration menu
    Copy the full SHA
    74de727 View commit details
    Browse the repository at this point in the history

  3. docs: mkdocs requires black to format signature rendering 

    The signature of function/classes is rendered in documentation based on
black format style. The package is then required to correctly rendered
signatures.
    @cofri
    cofri committed Nov 3, 2023
    Configuration menu
    Copy the full SHA
    3454bd6 View commit details
    Browse the repository at this point in the history