Articles of python sphinx

Usando Sphinx para generar automáticamente un documento separado para cada función

He estado construyendo un módulo de Python con muchas funciones diferentes. Estoy usando Sphinx y readthedocs para proporcionar documentación. He hecho un progreso decente, pero actualmente tengo una página masiva que proporciona la documentación para todas mis funciones (en orden alfabético). He visto otros proyectos que tienen una página separada para cada función. Al examinar […]

Extraer bloques de texto de documentos ReST por: ref :?

Tengo algunos documentos reStructuredText. Me gustaría usar fragmentos de él en la ayuda en línea. Parece que un enfoque sería ‘cortar’ piezas de marcado por referencia, por ejemplo, .. _my_boring_section: Introductory prose —————— blah blah blah .. _my_interesting_section: About this dialog —————– talk about stuff which is relevant in contextual help ¿Cómo podría usar python […]

utilizando la utilidad sphinx-apidoc de Sphinx para generar automáticamente la documentación desde el código de Python

Me pregunto cuál es el formato de comentarios para tener un código de auto-documentación utilizando la utilidad sphinx-apidoc de Sphinx. Puedo obtener esta utilidad para generar un conjunto de archivos reStructuredText para cada archivo de Python, pero estos archivos aún deben completarse. Estoy buscando una forma de obtener esta utilidad, o alguna otra utilidad de […]

Incrustar reStructuredText en las cadenas de documentación de Python

Me gustaría ver un buen resaltado de syntax y colorear en las cadenas de documentación de mi Python que (por supuesto) son RESt válidas. Por ejemplo: ”’ A section ========= an example:: some code ”’ rest of python code Lo más cercano que tengo es esto en mi .vim/after/syntax/python.vim : syn include syntax/rst.vim syn region […]

Flujo de trabajo de documentación de Sphinx y JavaScript

Para mi framework de JavaScript me gustaría usar Sphinx. Ya que soy nuevo en el mundo de la esfinge, me gustaría que ustedes me ayuden a comenzar con Sphinx y JavaScript. Cualquier ayuda apreciada. Atentamente

¿Cómo cambia el tamaño de fuente del ejemplo de código en la salida de PDF de LaTeX con la esfinge?

Creo que la fuente de ejemplo de código predeterminada en el PDF generado por la esfinge es demasiado grande. He intentado ensuciarme las manos en el archivo .tex generado insertando comandos de tamaño de fuente como \tiny sobre los bloques de código, pero solo hace que la línea sobre el bloque de código sea pequeña, […]

¿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 […]