Home

This site contains the project documentation for the python_template project.

Table Of Contents

The documentation follows the best practice for project documentation as described by Daniele Procida in the Diátaxis documentation framework and consists of four separate parts:

1. Tutorials
2. How-To Guides
3. Reference
4. Explanation

Quickly find what you're looking for depending on your use case by looking at the different pages.

MkDocs

• For full documentation visit mkdocs.org.

# Create a new project.
mkdocs new [dir-name]

# Start the live-reloading docs server.
mkdocs serve

# Build the documentation site.
mkdocs build

# Print help message and exit.
mkdocs -h