Auto Generated Documentation

Documentation with Sphinx

Tasks:

1. Take existing Python project or create a new one (for example Django project).

2. Create Sphinx documentation project for your Python project.

3. Import the documentation into Read the Docs.

4. Add autogenerated API documentation to the documentation project.

Here are some helpful links:

• Sample Sphinx documentation project

• Sphinx automatic documentation generation from code

Doucmentation with Mkdocs

Do the same tasks, but this time use Mkdocs instead of Sphinx.

Here are some helpful links:

• Sample mkdocs documentation project.