Articles of python sphinx

Python Sphinx hace referencia a nombres largos

Estoy trabajando en la documentación para mi módulo de Python (usando Sphinx y reST), y estoy descubriendo que al hacer referencias cruzadas con otros objetos de Python (módulos, clases, funciones, etc.) el nombre completo del objeto termina siendo increíblemente largo. A menudo es más de 80 caracteres, lo que me gustaría evitar a toda costa. […]

¿Cómo puedo documentar miembros en secciones específicas utilizando Sphinx?

Estoy luchando para averiguar cómo colocar la documentación para miembros específicos de mi clase de Python en secciones específicas de mi documentación de Sphinx, idealmente mientras se documenta automáticamente el rest en otra sección. Tengo una clase de python class MyClass(object): def funky(self, arg): “””Some docs.””” … definido en my/module.py que funciona como se esperaba […]

Sphinx elimina el formato de código de la referencia de código personalizado

Tengo las siguientes clases: class A: def x(): “”” Do the thing. “”” class B(A): def x(): “”” Do the thing, but better than the :py:meth:`parent ` “”” Todo el módulo es autodoc ed. Me gustaría tener un enlace a la implementación principal de x que se muestre como “principal”, no como ” parent “. […]

¿Puedo suprimir la expansión de variables en la documentación de Sphinx?

En mi codigo tengo X_DEFAULT = [‘a’, ‘long’, ‘list’, ‘of’, ‘values’, ‘that’, ‘is’, ‘really’, ‘ugly’, ‘to’, ‘see’, ‘over’, ‘and’, ‘over’, ‘again’, ‘every’, ‘time’, ‘it’, ‘is’, ‘referred’, ‘to’, ‘in’, ‘the’, ‘documentation’] y después def some_function(…, x=X_DEFAULT, …): de modo que en mi documentación de Sphinx, usando (p. ej., usando .. autofunction:: , etc.) obtengo el valor […]

Obteniendo Github contribuyentes de archivos individuales

Estoy planeando crear un complemento para el complemento del sistema de documentación Sphinx que muestre los nombres y los enlaces de perfil de Github de las personas que han contribuido a la página de documentación. Github tiene esta característica internamente ¿Es posible obtener los enlaces de perfil de Github de los contribuidores de archivos a […]

Evite el anidamiento de subsecciones en Python Sphinx cuando se usa toctree

Tengo un problema al estructurar mi guía de usuarios de Sphinx. Me gustaría formar un capítulo teniendo una página de inicio principal (index.rst) que contenga el encabezado del capítulo y una descripción general, y luego subsecciones separadas contenidas en diferentes archivos (part1.rst, part2.rst). Estoy tratando de usar “toctree” para insertar las subsecciones separadas, pero me […]

¿Cómo puedo hacer que los atributos del objeto de documento Python / Sphinx se declaren solo en __init__?

Tengo clases de Python con atributos de objeto que solo se declaran como parte de la ejecución del constructor, así: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for run in os.listdir(self.basepath): if self.foo(run): temp.append(run) self.availableruns = tuple(sorted(temp)) Si ahora uso la help(Foo) o bash documentar Foo en Sphinx, los self.basepath y […]

Cómo documentar paquetes de Python usando Sphinx

Estoy tratando de documentar un paquete en Python. En este momento tengo la siguiente estructura de directorios: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── Makefile ├── mod1 │ ├── foo.py │ └── __init__.py ├── mod2 │ […]

‘Título de sección inesperado’ con Sphinx: ¿es el problema el problema?

Cuando se ejecuta sphinx-build . html/ en mi directorio doc/ , obtengo el siguiente resultado: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using default: html loading pickled environment… done building [html]: targets for 0 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sources… [100%] […]

django sphinx automodule – conceptos básicos

Tengo un proyecto con varias aplicaciones grandes y donde se dividen los archivos de configuración y aplicaciones. La estructura del directorio es algo así: nombre del proyecto __init__.py aplicaciones __init__.py app1 app2 Tercera parte __init__.py lib1 lib2 ajustes __init__.py Install_apps.py path.py templates.py locale.py … urls.py cada aplicación es así __init__.py administración __init__.py file1.py file2.py modelos […]