Articles of python esfinge

El autodoc de Sphinx muere en ImportError de un paquete de terceros

¿Hay alguna forma de excluir la parte de importación de un módulo y luego documentarla con sphinx-python? Tengo un módulo que importa otro paquete (otro proyecto diferente) y luego la esfinge da este error: “” “Archivo” /usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7.egg/sphinx/ext/autodoc.py “, línea 321, en import_object import (self. nombre de archivo) Archivo “/home/x/GitHub/project/mod_example1.py”, línea 33, desde otro_pck importa Klass, […]

agregando contenido XML a la esfinge generada doc

Pues aqui esta mi problema. Estoy tratando de generar documentación para mi proyecto usando la esfinge y logré el trabajo básico, como agregar módulos e imágenes. Así que un index.rst básico se vería así: .. |tvb| replace:: `The Project` .. _tvb: http://www.myproject.org .. |logo| image:: img/evil_tvb_logo_transparent.svg :alt: The Project :align: top :height: 148 :target: tvb_ […]

¿Cómo agrego el enlace ‘Capítulo anterior’ y ‘Capítulo siguiente’ en la documentación generada por Sphinx?

Cuando veo la documentación, la mayoría de las páginas tienen un capítulo / enlace anterior y el siguiente enlace / botón en la parte inferior, por ejemplo, virtualenv . No puedo descubrir cómo lograr esto para la documentación de mi proyecto usando la herramienta de documentación Sphinx . ¿Podría alguien decirme cómo funciona esto o […]

¿Cuál es el estándar de documentación de Sphinx para los tipos de estructura de datos, como las listas?

¿Tiene Sphinx un estándar compatible para documentar los argumentos o tipos de valores de retorno que no son un objeto simple y único? Por ejemplo, a continuación, arg1 es una cadena, arg2 es una lista de cadenas y arg3 es una cadena o int. ¿Cómo se pueden especificar tipos de colección o compuestos en Sphinx? […]

Documentación de atributos de la clase Sphinx.

He intentado documentar mi aplicación basada en MongoEngine , pero tengo problemas con la documentación de atributos en mis clases de documentos. He tomado la syntax correcta para hacerlo es la siguiente: class Asset(Document): #: This is the URI of the document uri = StringField() He intentado todas las formas de documentar estos atributos que […]

Esfinge, las mejores prácticas.

Acabo de comenzar a usar la herramienta Sphinx para generar una documentación para mi código. Pero estoy un poco confundido porque no es tan fácil como esperaba. Creo el documento Sphinx usando: sphinx-quickstart y luego creo mis archivos * .rst en la carpeta “fuente”. Parece que necesito crear un archivo * .rst para cada módulo […]

Haz que la esfinge reemplace el texto de la cadena de documentos

Estoy documentando código en Sphinx que se parece a esto: class ParentClass(object): def __init__(self): pass def generic_fun(self): “””Call this function using /run/ParentClass/generic_fun()””” do_stuff() class ChildClass(ParentClass): def specific_fun(self): “””Call this function using /run/ChildClass/specific_fun()””” do_other_stuff() ChildClass los :inherited-members a la documentación de ChildClass , así que tengo declaraciones como “Llame a esta función usando / run / […]

Usando Sphinx con una extensión C construida por distutils

He escrito un módulo de Python que incluye un submódulo escrito en C: el módulo en sí se llama foo y la parte C es foo._bar . La estructura se ve como: src/ foo/__init__.py <- contains the public stuff foo/_bar/bar.c <- the C extension doc/ <- Sphinx configuration conf.py … foo/__init__.py importa _bar para boostlo, […]

Python Sphinx Autosummary: listado automatizado de funciones miembro

¿Cómo puedo decirle a la extensión de resumen automático que no solo incluya una sola clase sino también a todos los miembros de la clase? Si uso: .. autosummary:: MyClass En el archivo html resultante, solo habrá un breve resumen como: MyClass (var1, var2, ….) My Custom class para hacer cosas elegantes … Lo que […]

Incluir métodos especiales específicos en la esfinge.

Tengo un montón de clases que utilizan “métodos especiales”: class Foo(object): “Foo docstring” attr1 = “Attribute!” #: first attribute attr2 = “Another Attribute!” #: second attribute def __init__(self): self.x = 12 def say_hello(self): “”” say_hello(self) -> None Issue a friendly greeting. “”” print “Hello! x is {0}”.format(self.x) def __contains__(self,other): “””Implement “other in self“””” return other […]