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 documentation with direct use of MkDocs #398

Merged
merged 1 commit into from Apr 17, 2022
Merged

Improve documentation with direct use of MkDocs #398

merged 1 commit into from Apr 17, 2022

Commits on Apr 17, 2022

  1. Improve documentation with direct use of MkDocs 

    Improvements:

- Only the public API is documented
  - Thanks to `mkdocstrings` with `show_submodules: no`.
- Function parameter documentation is parsed and shown in tables.
- `None` paragraphs are removed.
  - This was reported at timothycrosley/pdocs#25
    but hasn't been merged.
- Footer layout is fixed.
  - It's currently broken with Portray, even on their own documentation
    (https://timothycrosley.github.io/portray/).
- Fix list levels in table of contents on home page.
  - Thanks to `mdx_truly_sane_lists`.
- Remove broken "edit" links.

Portray is great but I think we can do better by directly using MkDocs.

The new way to deploy the documentation is:

    mkdocs gh-deploy
    @bbc2
    bbc2 committed Apr 17, 2022
    Configuration menu
    Copy the full SHA
    e2f7999 View commit details
    Browse the repository at this point in the history