Preguntas etiquetadas con python-sphinx

Sphinx es una herramienta que facilita la creación de documentación inteligente y hermosa. Sphinx es especialmente adecuado para la documentación de Python, pero es una herramienta de propósito general que se puede utilizar para documentar cualquier cosa.

6
Sphinx autodoc no es lo suficientemente automático
Estoy tratando de usar Sphinx para documentar un proyecto de más de 5,000 líneas en Python. Tiene unos 7 módulos base. Hasta donde sé, para usar autodoc necesito escribir un código como este para cada archivo en mi proyecto: .. automodule:: mods.set.tests :members: :show-inheritance: Esto es demasiado tedioso porque tengo …
7
sphinx-build fail - autodoc no puede importar / buscar módulo
Estoy tratando de empezar con Sphinx y parece que tengo problemas implacables. Mando: docs/sphinx-quickstart Respondo todas las preguntas y todo funciona bien. Mando: docs/ls Todo parece normal. Resultado:build Makefile source Mando: sphinx-build -d build/doctrees source build/html Parece funcionar. Pude abrir el archivo index.html y ver un "shell" de lo que …
6
¿Puede Sphinx vincular a documentos que no se encuentran en directorios debajo del documento raíz?
Estoy usando Sphinx para documentar un proyecto que no es de Python. Quiero distribuir ./doccarpetas en cada submódulo, que contienen submodule_name.rstarchivos para documentar ese módulo. Luego quiero absorber esos archivos en la jerarquía maestra para crear una especificación para todo el diseño. Es decir: Project docs spec project_spec.rst conf.py modules …
4
Dar formato al texto de un enlace en reStructuredText
¿Cómo se formatea el texto dentro de un enlace indicado en reStructuredText? Específicamente, deseo generar el siguiente HTML a partir de mi primera: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> El resultado debería verse así: optparse.OptionParser documentación donde la parte "optparse.OptionParser" está en una fuente de ancho fijo. Lo intenté ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ sin …
1
La compilación de Read-the-docs falla con "no se puede importar el nombre 'PackageFinder' de 'pip._internal.index'"
La compilación de documentos de Sphinx en read-the-docs falla con el siguiente error (complete el registro a continuación): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) ¿Hice algo mal o es un error en leer los documentos? Una compilación local de documentos de Sphinx funciona bien. Registro de errores completo …
2
¿Por qué el archivo html convertido del primer archivo que contiene el signo de interrogación no se puede mostrar en el navegador cuando se hace clic en el catálogo?
Descargue el archivo simple.7ze instálelo en su esfinge para reproducir los problemas que describí aquí, para reproducirlo, puede ejecutar: make clean make html descargue e instale en su esfinge para reproducir problemas Hay dos artículos en sample/source, el contenido es el mismo, la única diferencia es el título. cd sample …
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.