Resultados de la búsqueda a petición "python-sphinx"

1 la respuesta

¿Qué efecto tienen los diferentes parámetros de URL de la función de búsqueda de salida HTML de Sphinx?

La documentación HTML generada por Sphinx incluye una interfaz de búsqueda. Por ejemplo, al buscar en la documentación oficial de Python el término "popen", se construye esta ...

2 la respuesta

¿Cómo puedo hacer que los atributos de objetos de documento de Python / Sphinx solo se declaren 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 ...

2 la respuesta

sphinx import padre dir primer archivo?

Necesito crear un proyecto de esfinge para cada módulo, y cada módulo comparte algunos primeros comunes, como información de la compañía, licencia, etc. Mi árbol de proyectos es así: ./conf.py ./index.rst ./intro.rst ./about.rst ...

1 la respuesta

RestructuredText: agregar atributos de título a los enlaces

Estoy tratando de usar una implementación jQuery lightBox en mi sitio web que se genera a partir de reStructuredText. El lightBox toma el título del enlace alrededor de las imágenes como el título de la imagen en la pantalla del lightBox. Sin ...

1 la respuesta

Fin del bloque literal en el elemento de la lista

Tengo un elemento de lista en mi primer archivo en el que me gustaría poner un bloque literal, pero no puedo hacer que el bloque literal finalice correctamente. Esta es mi primera: 1. Item 1 (not literal) 2. Item 2:: MyCode.example() ...

3 la respuesta

Generación automática de documentación para todo el contenido del paquete Python

Estoy tratando de generar automáticamente la documentación básica para mi base de código usando Sphinx. Sin embargo, tengo dificultades para indicarle a Sphinx que escanee recursivamente mis archivos. Tengo una base de código Python con una ...

3 la respuesta

En Sphinx, ¿hay alguna forma de documentar los parámetros junto con declararlos?

Prefiero documentar cada parámetro (según sea necesario) en la misma línea donde declaro el parámetro para aplicarSECO. [http://en.wikipedia.org/wiki/Don't_repeat_yourself] Si tengo un código como este: def foo( flab_nickers, # a series of ...

1 la respuesta

Cómo hacer que Sphinx Respect importe clases en un paquete con __init__.py

Tengo un paquete: foofoo.pybar.py__init__.pyfoo.py tiene una clase Foo. En __init__.py importo la clase Foo para que los usuarios puedan hacer: from foo import FooSphinx correctamente documenta a Foo como foo.foo.Foo, lo cual es correcto pero ...

1 la respuesta

¿Cómo deshabilito los colores en la salida de LaTeX generada por sphinx?

Cuando construyo el archivo LaTeX generado a partir de sphinx, las entradas de TOC y los encabezados de sección son azules. ¿Hay alguna manera fácil de desactivar la coloración de estos elementos? Si no, ¿hay alguna manera fácil de hacerlos ...

1 la respuesta

Dividir Sphinx TOC en subsecciones con subtítulos

Tengo un documento maestro de Sphinx que incluye documentos secundarios de la siguiente manera: .. toctree:: :maxdepth: 2 :numbered: doc1 doc2 doc3 doc4 doc5 doc6Me gustaría dividir el TOC en partes o subsecciones, para que se represente a lo ...