=============================
Auto Generated Documentation
=============================

Documentation with Sphinx
==========================

Tasks:

#. Take existing Python project or create a new one (for example Django project).
#. Create Sphinx documentation project for your Python project.
#. Import the documentation into Read the Docs.
#. Add autogenerated API documentation to the documentation project.

Here are some helpful links:

* Sample `Sphinx documentation project <https://github.com/readthedocs-examples/example-sphinx-basic/>`__
* Sphinx `automatic documentation generation from code <https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html>`__


Doucmentation with Mkdocs
==========================

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

Here are some helpful links:

* Sample `mkdocs documentation project <https://github.com/readthedocs-examples/example-mkdocs-basic/>`__.