a small package for demonstration the features of mkdocs
for python package documentation
For full documentation visit mkdocs.org.
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.
https://realpython.com/python-project-documentation-with-mkdocs/#insert-information-from-docstrings https://jupytext.readthedocs.io/en/latest/index.html https://mkdocs-jupyter.danielfrg.com https://github.com/marketplace/actions/deploy-mkdocs#building-with-github_token https://github.com/mhausenblas/mkdocs-template