Skip to content

WELCOME

Here we provide short tutorials on generating documentation, with the templates and coded provided in this tutorial repository.

  1. using markdown e.g. in README.md in a github repository
  2. using docstrings
  3. using pdoc3
  4. using mkdocs
  5. hosting

Examples of other documented projects

  • mdtraj:
    • Uses sphinx with ReadTheDocs theme. Note the "view page source" link on the top right of the page, which shows the reStructuredText used to write the page.
  • scikitlearn
    • the "view page source" is on the bottom left of the page
  • mkdocstrings
    • using a newer standard called mkdocs that is markdown-native, and the material theme.
  • pdoc3
    • a lightweight document generation, with no set up files!
    • can be more heavily themed, e.g. see the hikari project.
Back to top