Articles of python esfinge

Incluyendo docstring en la documentación de Sphinx

Me gustaría incluir solo la cadena de documentación de una función específica en mi documentación de Sphinx. Sin embargo, parece que no hay opciones para mostrar estos detalles sin las definiciones de funciones y clases asociadas utilizando http://sphinx.pocoo.org/ext/autodoc.html He intentado crear una clase como se describe en show * only * docstring en la documentación […]

Estructuración de la documentación de Sphinx.

Comencé a documentar un proyecto de Python usando Sphinx. Es la primera vez que lo uso. Estoy acostumbrado a las herramientas que funcionan con una syntax similar a JavaDoc, y tengo algunas dudas. Como quiero que la documentación aparezca cerca del código, hago uso de las .. automodule:: , .. autoclass:: y .. automethod:: . […]

¿Desea reStructuredText de sphinx autodoc?

CPython no usa autodoc para su documentación, usamos prosa escrita a mano. Para PEP 3144 (el módulo de dirección IP), me gustaría usar sphinx-apidoc para generar la documentación de referencia inicial. Eso significa que quiero ejecutar una operación de dos pases: Utilice sphinx-apidoc para emitir un proyecto Sphinx para el módulo que depende de autodoc […]

Enlace al método de clase en la cadena de documentación de Python

Quiero agregar un enlace a un método en mi clase desde dentro de la cadena de documentación de otro método de la misma clase. Quiero que el enlace funcione en la esfinge y preferentemente también en Spyder y otros IDE de Python. Probé varias opciones y encontré solo una que funciona, pero es incómoda. Supongamos […]

¿Cómo agregar un archivo css personalizado a Sphinx?

¿Cómo puedo agregar un archivo css personalizado? La siguiente configuración no funciona para mí: # conf.py html_static_path = [‘_static’] html_theme = ‘default’ html_theme_options = { ‘cssfiles’: [‘_static/style.css’] } Resultado: C:\temp\test-docs\docs>make html Running Sphinx v1.2.2 loading pickled environment… not yet created building [html]: targets for 2 source files that are out of date updating environment: 2 […]

¿Cómo subir la documentación html generada desde la esfinge a github?

Acabo de documentar cargas de mi código y aprendí a usar la esfinge para generar la documentación. Quiero incluir eso en mi página de proyecto github pero no sé cómo hacerlo. ¿Alguien sabe tutorial existente o paso simple para hacerlo? Gracias.

Problemas con autodoc y atributos de instancia explícitamente especificados

Escribí una clase de python e hice la documentación con esfinge. Por ejemplo, la clase se ve como: class Aclass(object): “”” my class “”” def __init__(self): “”” constructor “”” self.a = None “”” doc for attribute a “”” self._prop = None def _get_prop(self): “”” getter prop “”” return self._prop def _set_prop(self, val): “”” setter prop […]

¿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, cuando se busca en la documentación oficial de Python el término “popen”, esta URL se construye: https://docs.python.org/3/search. ¿Qué efecto tienen los diferentes parámetros de URL?

Incluir un archivo de texto * como está * en (Python) Sphinx Docs

(usando la herramienta de documentación Python-Sphinx) Tengo un archivo de registro .txt que me gustaría construir en _build/html sin _build/html . ¿Qué necesito alterar en conf.py , index.rst , etc.? Aquí está el diseño: src/ index.rst some_doc.rst somefile.txt ¿Cómo obtengo somefile.txt en la comstackción html? Intenté agregar una línea como esta a index.rst : Contents: […]

Modificar el árbol TOC de Sphinx

Tengo un proyecto Sphinx con un TOC ( index.rst ) que incluye :maxdepth: 2 . El problema es que quiero reducir la profundidad a 1 para la sección de release para que no incluya la lista de notas de lanzamiento en la tabla de contenido principal (la lista es demasiado larga). Parece que la lista […]