Articles of documentación de

Cómo hacer texto tachado en Sphinx

¿Es posible hacer tachado de texto en el generador de documentación de la esfinge?

¿Cuáles son estas tags @ivar @param y @type en la cadena de documentación de python?

El proyecto de ampolla usa algunas tags en docstring, como las de javadoc. Por ejemplo de la línea 86 de pool.py : def start(self, ampChild=None): “”” Starts the ProcessPool with a given child protocol. @param ampChild: a L{ampoule.child.AMPChild} subclass. @type ampChild: L{ampoule.child.AMPChild} subclass “”” ¿Qué son estas tags, qué herramienta lo utiliza.

Sphinx no encuentra paquetes de Python cuando usa autodoc

Estoy intentando crear documentación para el proyecto de prueba de Python antes de hacerlo para el proyecto real. Mi sistema: Win7 64 bit, python 2.7.5 64 bit. El nombre de mi proyecto es testDoc . Incluye python pakage, llamado t , que incluye 2 módulos t1 y t2 y __init__.py . __init__.py contiene: import t1 […]

La esfinge ha reportado enlaces rotos.

Al crear la documentación html, ¿cómo obliga a la esfinge a informar o crear un error en los enlaces que no existen? Específicamente, tengo propiedades y métodos dentro de mi proyecto de Python que han sido eliminados o renombrados, y es difícil encontrar todos los enlaces muertos con el resultado html generado por la esfinge. […]

Hacer un archivo PDF de la documentación de Python

El sitio oficial de Python ofrece descargas de documentación en PDF, pero están separados por capítulos. Descargué el código fuente y construí la documentación en PDF, que también eran archivos PDF separados. ¿Cómo puedo crear un archivo PDF desde el Makefile en el código fuente ? Creo que sería más conveniente leer. Si la concatenación […]

Cómo crear directivas personalizadas en Sphinx.

Actualmente estoy documentando una API de descanso escrita en Python. Toda la documentación del proyecto se crea con Sphinx, y para la API REST me gustaría crear algunas directivas especiales. Por ejemplo, digamos que tengo este recurso definido: @resource(“/user/”, method=”GET”) def user_details (email): “”” Returns detailed information about a user account. :resource GET: /user/ :query_param […]

¿Cómo puedo hacer referencia a un parámetro documentado de la función Python usando el marcado Sphinx?

Me gustaría hacer referencia a un parámetro de función previamente documentado en otra parte de una cadena de documentación de Python. Considere el siguiente ejemplo (ciertamente completamente artificial): def foo(bar): “””Perform foo action :param bar: The bar parameter “”” def nested(): “””Some nested function that depends on enclosing scope’s bar parameter. I’d like to reference […]

¿Cómo puedo configurar Sphinx para excluir condicionalmente algunas páginas?

Al generar documentación con Sphinx, me gustaría poder generar dos versiones de mi documentación: una que incluya todo y otra con solo un conjunto de páginas en particular. ¿Cuál es la mejor manera de lograrlo? Podría escribir un script de comstackción que mueva los archivos para lograr esto, pero sería muy bueno si hubiera una […]

Python-Sphinx: ¿Cómo documentar un archivo con funciones?

Tengo un archivo de python con funciones (lib.py), sin clases. Cada función tiene el siguiente estilo: def fnc1(a,b,c): ”’ This fonction does something. :param a: lalala :type a: str :param b: hahaha :type b: int :param c: hohoho :type c: int :rtype: int ”’ print a d = b + c return d Solo quiero […]

Combinando la documentación de Sphinx de múltiples subproyectos: manejo de índices, configuración de sincronización, etc.

Tenemos un proyecto de varios módulos documentado con la (excelente) Sphinx. Nuestra configuración no es diferente a la descrita en la lista de correo . En general, esto funciona muy bien ! Pero tenemos algunas preguntas acerca de hacerlo: Las tablas de contenidos del submódulo incluirán enlaces de índice. En el mejor de los casos, […]