Improve documentation with direct use of MkDocs#398
Merged
theskumar merged 1 commit intotheskumar:masterfrom Apr 17, 2022
Merged
Improve documentation with direct use of MkDocs#398theskumar merged 1 commit intotheskumar:masterfrom
theskumar merged 1 commit intotheskumar:masterfrom
Conversation
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
Owner
Portray was meant to be easy to use and low maintenance. It seems it is not well maintained and introducing unwanted bottlenecks, also the project now needs more comprehensive docs, let's move forward with mkdocs. While I think the current PR can be merged as-is. I would like to use the opportunity to document more improvements that this project can benefit from. We can address them as these as we go:
|
theskumar
approved these changes
Apr 17, 2022
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` ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improvements:
mkdocstringswithshow_submodules: no.Noneparagraphs are removed.mdx_truly_sane_lists.Portray is great but I think we can do better by directly using MkDocs.
The new way to deploy the documentation is:
The result can currently temporarily be seen at https://bbc2.github.io/python-dotenv/.