Improve documentation with direct use of MkDocs by bbc2 · Pull Request #398

Improve documentation with direct use of MkDocs by bbc2 · Pull Request #398 · theskumar/python-dotenv

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 deleted the better-doc branch

April 18, 2022 08:14

theskumar added a commit that referenced this pull request

Jun 5, 2022

* master: (111 commits)
  chore: add how to run docs locally
  Improve documentation with direct use of MkDocs (#398)
  feat(cli): add support for execution via 'python -m' (#395)
  Use built-in unittest.mock instead of third-party mock
  Skip test_ipython if IPython is not available (#397)
  Docs: Improve documentation for variables without value (#390)
  Use `open` instead of `io.open`
  Fix link typo in changelog
  Release version 0.20.0
  Don't mark wheels as universal (#387)
  Fix installing entry points
  Add encoding parameter to {get,set,unset}_key
  chore: add test with Python 3.11 (#368)
  Release version 0.19.2
  Add missing trailing newline when adding new value
  Release version 0.19.1
  Add Python 3.10 support (#359)
  CHANGELOG.md: Fix typos discovered by codespell
  Release version 0.19.0
  Allow any text stream (`IO[str]`) as `stream`
  ...