Eu estou tentando criar automaticamente documentos de API para uma base de código python grande usando Sphinx.

Eu tentei usar build_modules.py e sphinx-apidoc. Com qualquer um deles, posso obter primeiro docs criados com sucesso no meu diretório de saída para os pacotes e módulos de nível superior.

No entanto, quando eu construo usando

make html

dá milhares de erros deste tipo:

<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'rstDocs/src.Example1.class1.method1'

para cada classe e método na base de código. Com alguma experimentação, acho que descobri que as diretivas autosummary / autoclass estão criando as áreas que esperam que existam primeiros arquivos para cada classe e método.

Além dos avisos, a documentação parece funcionar bem, mas eu gostaria de me livrar deles e acho que posso ter configurado algo errado.

Eu também tenteinipype / tools para o mesmo efeito.

eu modifiqueiapigen.py ebuild_modref_templates.py para criar primeiros stubs para cada um desses documentos "ausentes", com autoclass / autofunction / automethods, conforme apropriado. No entanto, a compilação leva muito tempo (10 minutos) e, eventualmente, falha devido a erros de memória na última etapa de compilação.

Aqui está um exemplo de arquivo rst módulo que cria todos os avisos:

src Package
===========

:mod:`src` Package
------------------

.. automodule:: src.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`Example1` Module
------------------------------------

.. automodule:: src.Example1
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`Example2` Module
------------------

.. automodule:: src.Example2
    :members:
    :undoc-members:
    :show-inheritance:

Obrigado por qualquer conselho sobre como resolver esses avisos! Eu gostaria de ficar longe de qualquer solução que envolve a modificação dos arquivos do pacote do site da Esfinge.