es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

¿Por qué sphinx-autoapi muestra una referencia de API vacía?

No puedo hacer que esto funcione;

Tengo la siguiente estructura

testdoc/
init.py
docs/ #directorio de Sphinx
lib/
init.py
a.py

a.py contiene una sola clase con docstrings.

Inicialicé una nueva documentación de Sphinx en testdoc/docs y cambié mi config.py a:

import os
import sys
sys.path.insert(0, os.path.abspath('..'))
[...]
extensions = ['autoapi.extension','sphinx.ext.autodoc', 'sphinx.ext.inheritancediagram']
autoapimodules = {'testdoc.lib.a': {}}

Document Python Code

autoapitype = 'python'
autoapidirs = ['../lib']
[...]

Estoy usando la salida HTML.
AutoAPI lee el módulo testdoc.lib.a y genera muchos archivos en docs/_build/autoapi:

index.html
testdoc/
lib/
index.html
a/
index.html

Entonces, la documentación se genera y se ve bien.

En la página principal de la documentación, hay un enlace a la referencia de la API. Sin embargo, esta referencia de API no enlaza con el módulo; está vacía. ¿Estoy haciendo algo mal? Esperaba que el módulo apareciera en la referencia de la API.

Adjunto el archivo de registro. Me di cuenta de que se refiere a un archivo autoapi\testdoc\lib\a\index.rst que no aparece en mi estructura de directorios.
“`
Running Sphinx v4.2.0
loading pickled environment… done
[AutoAPI] Reading files… [100%] testdoc\lib_init.py
[AutoAPI] Mapping Data… [100%] testdoc\lib_init.py
[AutoAPI] Rendering Data… [ 50%] testdoc.lib.a
[AutoAPI] Rendering Data… [100%] testdoc.lib

[autosummary] generating autosummary for: autoapi\index.rst, autoapi\testdoc\lib\a\index.rst, autoapi\testdoc\lib\index.rst, index.rst
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: 0 added, 3 changed, 0 removed
reading sources… [100%] autoapi/testdoc/lib/index
looking for now-outdated files… none found
pickling environment… done
checking consistency… testdoc\docs\autoapi\index.rst: WARNING: document isn’t included in any toctree
testdoc\docs\autoapi\testdoc\lib\index.rst: WARNING: document isn’t included in any toctree
done
preparing documents… done
writing output… [100%] index
generating indices… genindex py-modindex done
writing additional pages… search done
copying static files… done
copying extra files… done
dumping search index in English (code: en)… done
dumping object inventory… done
build succeeded, 2 warnings.

Las páginas HTML están en _build\html.

Tags:  , ,

Answer

  1. Avatar for davy.ai

    Parece que el problema está relacionado con el hecho de que el archivo autoapi\testdoc\lib\a\index.rst no se está generando. Es posible que la configuración de autoapi_modules no esté configurada correctamente. Por favor, verifique que la configuración esté configurada correctamente y que autoapi_modules esté apuntando al módulo correcto.

Comments are closed.