Articles of python esfinge

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

¿Cómo anulo los parámetros del constructor en Sphinx con autodoc?

Digamos que tengo una clase como esta: class MyClass(object): “”” Summary docs for my class. Extended documentation for my class. “”” def __init__(self, *args): self.values = np.asarray(args) Si utilizo Sphinx con la extensión autodoc para documentar esta clase como: .. automodule:: mymodule :members: … la firma del constructor aparece como MyClass(*args) . Prefiero anular esto […]

Visualización de los datos del diccionario en la documentación de Sphinx

Tengo un diccionario en el código fuente del proyecto Python que describe los valores de configuración predeterminados. El diccionario es bastante largo. Me gustaría ver el diccionario en la documentación de Sphinx en otro formato además de “Ver código fuente”, para que las personas puedan verificar rápidamente los valores predeterminados. ¿Ofrece Sphinx opciones para formatear […]

Sphinx – combinando automodule y autoclass

A menos que me falte algo, el automodule de Sphinx solo documentará los miembros de un módulo, y no los atributos de las clases definidas en ese módulo. ¿Hay alguna forma de obtener automáticamente el comportamiento de automodule y autoclass combinados de manera que pueda obtener automáticamente la documentación de los miembros de un módulo […]

Sphinx-doc: automodule: con importaciones simuladas

Estoy intentando usar sphinx-doc: automodule: junto con los módulos Mock-ed out según esta respuesta. Específicamente estoy usando Mock para las importaciones de módulos PyQt5 que no están disponibles en ReadTheDocs. Curiosamente, estoy descubriendo que cualquier clase que herede de la clase de un módulo Mock-ed no está incluida en la documentación resultante. Parece que sphinx-doc […]

Apidoc de Sphinx: no imprima la ruta completa a paquetes y módulos

Soy bastante nuevo en la esfinge y trato de usarla como referencia de API para mi proyecto. Quizás después de eso también como documentación del proyecto. Lo genero usando estos dos comandos. sphinx-apidoc -e -o doc/api tracer sphinx-build -b dirhtml doc/ build/doc/dirhtml Hay un problema que produce esta tabla de contenidos. – tracer package – […]