Articles of python sphinx

¿Por qué podría doctests generar un NameError cuando se ejecuta con `make doctest` de Sphinx?

Tengo una función simple con un doctest , que, cuando se ejecuta con make doctest Sphinx, me da el siguiente error: File “scheemey.rst”, line ?, in default Failed example: verify_balanced(‘asdf (foo [bar] [[baz], {}, ()]’) Exception raised: Traceback (most recent call last): File “/usr/local/Cellar/python/2.7.8/Frameworks/Python.framework/Versions/2.7/lib/python2.7/doctest.py”, line 1315, in __run compileflags, 1) in test.globs File “”, line […]

Cómo enlazar a la página raíz en intersphinx

He habilitado sphinx.ext.intersphinx en mi proyecto y he agregado la siguiente configuración: intersphinx_mapping = { ‘python’: (‘https://docs.python.org/3’, None), ‘pyserial’: (‘https://pythonhosted.org/pyserial/’, None), } Tengo lo siguiente en mi index.rst : This project depends on the :ref:`pyserial ` library. Me gustaría que el enlace apunte a http://pythonhosted.org/pyserial/ , la URL raíz en intersphinx_mapping , pero no sé […]

Las importaciones relativas requieren el argumento ‘paquete’

Quiero usar Sphinx para que pueda generar automáticamente un pydoc para mi código de Python, pero obtengo un error. ¿Qué hago mal? Conf.py archivo de configuración de la esfinge import sys import os from django.conf import settings os.environ[‘DJANGO_SETTINGS_MODULE’] = ‘../cloud_server.settings’ sys.path.insert(0, os.path.abspath(‘../cloud_server/cloud_api’)) views.py archivo django from django.contrib.auth.models import User, Group from rest_framework import viewsets from […]

sphinx automodule: ¿cómo hacer referencia a las clases en el mismo módulo?

Estoy tratando de usar la extensión autodoc sphinx y específicamente la directiva automodule para generar automáticamente la documentación para la aplicación django en la que estoy trabajando. El problema es que quiero crear referencias internas a diferentes clases dentro del módulo, sin tener que usar autoclase y autofuncionar en cada clase / función dentro del […]

Mostrar todo el texto en la barra lateral Leer los documentos.

Según tengo entendido, el nuevo tema Leer los documentos genera la barra lateral del toctree con una profundidad de 2. Mi documentación es relativamente profunda y una profundidad de 2 no es suficiente para que sea útil. ¿Cómo puedo boost este límite, o preferiblemente eliminarlo por completo? Si eso no es razonablemente posible, ¿cómo puedo […]

¿Repetir la cuadrícula de imagen con subtítulos?

Como una extensión de esta pregunta : ¿cómo puede agregar una descripción debajo de cada una de las imágenes en cuadrícula utilizando Sphinx y reStructuredText? Por ejemplo, una tabla, tres imágenes con un título centrado debajo de cada imagen.

Progtwig de línea de comandos de Python: genere una página de manual a partir de la documentación existente e incluya en la distribución

Siguiendo una práctica común (con suerte), tengo un paquete de Python que incluye varios módulos y un script ejecutable en un directorio de scripts separado, como se puede ver aquí . La documentación para el script, además de la ayuda generada automáticamente por optparse, está junto con la documentación del paquete en un subdirectorio Sphinx. […]

Cómo crear directivas personalizadas en Sphinx.

Actualmente estoy documentando una API de descanso escrita en Python. Toda la documentación del proyecto se crea con Sphinx, y para la API REST me gustaría crear algunas directivas especiales. Por ejemplo, digamos que tengo este recurso definido: @resource(“/user/”, method=”GET”) def user_details (email): “”” Returns detailed information about a user account. :resource GET: /user/ :query_param […]

¿Cómo express varios tipos para un solo parámetro o un valor de retorno en las cadenas de documentos procesadas por Sphinx?

A veces, una función en Python puede aceptar un argumento de un tipo flexible. O puede devolver un valor de un tipo flexible. Ahora no puedo recordar un buen ejemplo de tal función en este momento, por lo tanto, estoy demostrando cómo se ve esa función con un ejemplo de juguete a continuación. Quiero saber […]

Formato de tabla csv en las cadenas de documentación de Python (Sphinx): múltiples líneas en una celda

Estoy usando Sphinx para documentar un proyecto de Python. Parece que hay un poco de inconsistencia con la directiva .. csv-table:: . El problema principal es una nueva línea en una celda. Y mi cuestionable salud mental. El siguiente código: .. csv-table:: :header: Header1, Header2, Header3 A, B, “These lines appear as one line, even […]