I will write API python sphinx, mkdocs documentation

Having a good documentation means that your users can enjoy your software or tutorial efficiently and in a short amount of time. There are lots of available tools, but Sphinx is a de-facto standard for Python. You can also use Sphinx for any kind of tutorials.

Sphinx can also read notes in the code and output beautiful documentation.

I can help you:

• document your API (Django, FastAPI) and/or create your tutorial from scratch
• write notes in your code so they can be read by Sphinx (docstrings)
• initialize Sphinx so that it can read function or class docstrings
• improve your existing documentation, also by adding references
• give you suggestions to improve your documentation
• help you fix problems to build the Sphinx documentation (extra)
• add Python type annotation in your API code: improves code and documentation quality (extra)
• Quarto, Mkdocs, and can improve your FastAPI endpoint descriptions

Sphinx can generate output in various formats. Usually the most common one is HTML.

I can write your documentation in English, Italian or French.

My Python projects and my tutorials use Sphinx. I use:

• GNU/Linux
• GIT repositories
• RST, markdown files
• venv
• Makefiles
• Docker (docker-compose)