A documentação é gerada com Sphinx-Quickstart, mas primeiro, os requisitos da Esfinge devem ser instalados com PIP:
Vamos começar com a documentação de extensão e gerar HTML para ele.Ivan Kud
em
Dentro da vista
–
Oleg Abramov
em
Dentro da vista
–
Ivan Kud
em
Dentro da vista
–
Ivan Kud
em
Dentro da vista
–
Julie Perilla Garcia
em
Codificação de nível para cima
–
17
Max Hilsdorf
em
Em direção à ciência de dados
–
2
Dominik Polzer
em
Em direção à ciência de dados
–
10
Vitor Cerqueira
em
Em direção à ciência de dados
–
Wenqi Glantz
em
Melhor programação
–
2
JP Brown
–
328 Então, comecei a pesquisar como documentar peças de código exportadas pelo Python e gerar a documentação para eles: infelizmente, quase não há informações sobre isso.Eu forneço makefile pronto para uso na raiz do projeto:
Ele constrói o projeto de extensão, o instala no Venv e constrói os documentos.Na minha primeira extensão, acabei de escrever um arquivo de marcha com API:
Definitivamente, não é a melhor abordagem possível.
Fonte: https://blog.savant-ai.io/documenting-native-python-extensions-made-with-rust-and-pyo3-227aff68e481
