sphinxs program python python-2.7 python-sphinx

python - sphinxs - sphinx program



Sphinx autosummary "toctree contiene referencia a advertencias de documento inexistente" (2)

Perdón por una respuesta tardía (si se puede considerar), pero encontré este enlace que analiza lo que puede estar sucediendo con usted:

https://github.com/phn/pytpm/issues/3#issuecomment-12133978

La idea de que si tiene algún raspador Doc especial en su código de documentación que está creando documentación autosummary después de que autosummary ya se haya ejecutado puede ser algo para investigar si todavía tiene este problema. Aunque no estoy seguro de cuánta ayuda será.

La clave del enlace es agregar: numpydoc_show_class_members = False a conf.py

Estoy tratando de crear automáticamente api docs para una gran base de código python con Sphinx.

He intentado usar build_modules.py y sphinx-apidoc. Con cualquiera de los dos, puedo obtener los primeros documentos creados con éxito en mi directorio de salida para los paquetes y los módulos de nivel superior.

Sin embargo, cuando construyo usando

make html

da miles de errores de este tipo:

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

para cada clase y método en la base de código. Con un poco de experimentación, creo que he descubierto que las directivas autosummary / autoclass están creando toctres que esperan que haya primeros archivos para cada clase y método.

Aparte de las advertencias, la documentación parece funcionar bien, pero me gustaría deshacerme de ellas y creo que puedo haber configurado mal algo.

También probé nipype/tools para obtener el mismo efecto.

apigen.py y build_modref_templates.py para crear primeros stubs para cada uno de estos documentos "faltantes", con autoclass / autofunction / automethods según corresponda. Sin embargo, la compilación tarda bastante tiempo (10 minutos) y finalmente se bloquea debido a errores de memoria en el último paso de compilación.

Aquí hay un primer archivo de módulo de ejemplo que crea todas las advertencias:

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:

¡Gracias por cualquier consejo sobre cómo hacer que estas advertencias se resuelvan! Me gustaría mantenerme alejado de cualquier solución que implique modificar los archivos del paquete del sitio de sphinx.