Tag: PYTHON-SPHINX
.. list-table:: Título :widths: 25 20 30 30 :header-rows: 1 <ul> <li><ul> <li>Nombre del campo <ul> <li>Tipo de datos</li> <li>Valores</li> <li>Descripción</li> </ul></li> </ul></li> <li><ul> <li>punto de ebullición<em>f</em> <ul> <li>JSON</li> <li>pruebas</li> <li>.. list-table:: testTitle :widths: 25 25 50 <ul> <li><ul> <li>prueba1</li> </ul></li> <li><ul> <li>prueba2</li> </ul></li> <li><ul> <li>prueba3 “`</li> </ul></li> </ul></li> </ul></li> . . . Read more
¿Existe alguna manera de establecer un valor predeterminado para una opción de directiva en Sphinx en conf.py, para que se utilice siempre que se use esa directiva? En particular, estoy utilizando autosummary y siempre quiero que :toctree: esté establecido para que no tenga que escribirlo todas las veces y nunca . . . Read more
Para las clases/funciones, la extensión autosummary de Sphinx puede generar una tabla agradable que resume la lista de clases/funciones disponibles en un módulo particular, de tal manera que la primera columna consiste en una lista de estos elementos, y la segunda columna consiste en la primera línea tomada de docstrings . . . Read more
Tengo dos plantillas de clase y necesito documentarlas usando Sphinx. Como de costumbre, he usado comentario de estilo Doxygen para las clases. Pero, aunque he usado la directiva Doxygen no puedo obtener la documentación correcta. Clases de muestra “`namespace X { /// Clase Base /** * Descripción de la Clase . . . Read more
¿Es posible establecer la ruta del módulo Python Sphinx autodoc desde Jupyter Book, por ejemplo a través de _config.yml? Estoy usando Jupyter Book para documentar un sistema Python y publicarlo en Read The Docs. Puedo establecer la ruta del módulo desde Sphinx agregando código como este a conf.py: import os . . . Read more