Vou escrever API python sphinx, documentação mkdocs

Ter uma boa documentação significa que seus usuários podem aproveitar seu software ou tutorial de forma eficiente e em pouco tempo. Existem muitas ferramentas disponíveis, mas o Sphinx é o padrão de fato para Python. Você também pode usar o Sphinx para qualquer tipo de tutorial.

O Sphinx também consegue ler notas no código e gerar uma documentação bonita.

Posso te ajudar a:

• documentar sua API (Django, FastAPI) e/ou criar seu tutorial do zero
• escrever notas no seu código para que possam ser lidas pelo Sphinx (docstrings)
• inicializar o Sphinx para que ele possa ler as docstrings de funções ou classes
• melhorar sua documentação existente, também adicionando referências
• te dar sugestões para melhorar sua documentação
• ajudar a resolver problemas na construção da documentação com Sphinx (extra)
• adicionar anotações de tipo Python no seu código de API: melhora a qualidade do código e da documentação (extra)
• Quarto, Mkdocs, e podem melhorar as descrições dos seus endpoints FastAPI

O Sphinx pode gerar saída em vários formatos. Geralmente, o mais comum é HTML.

Posso escrever sua documentação em inglês, italiano ou francês.

Meus projetos em Python e meus tutoriais usam Sphinx. Eu uso:

• GNU/Linux
• repositórios GIT
• arquivos RST, markdown
• venv
• Makefiles
• Docker (docker-compose)