Articles of python python sphinx

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

Mostrar * solo * docstring en la documentación de Sphinx

Sphinx tiene una función llamada automethod que extrae la documentación de la cadena de documentación de un método y la incrusta en la documentación. Pero no solo incrusta la cadena de documentación, sino también la firma del método (nombre + argumentos). ¿Cómo puedo incrustar solo la cadena de documentación (excluyendo la firma del método)? ref: […]

¿Cuál es la forma correcta de documentar un parámetro de ** kwargs?

Estoy usando sphinx y el complemento autodoc para generar documentación de API para mis módulos de Python. Aunque puedo ver cómo documentar bien parámetros específicos, no puedo encontrar un ejemplo de cómo documentar un parámetro de **kwargs . ¿Alguien tiene un buen ejemplo de una manera clara de documentar esto?

¿Alguien ha usado Sphinx para documentar un proyecto de C ++?

Sphinx es una nueva herramienta de documentación para Python. Se ve muy bien. Lo que me pregunto es: ¿Qué tan adecuado es esto para documentar un proyecto de C ++? ¿Existen herramientas para convertir la documentación existente (por ejemplo, doxygen) al formato Sphinx? ¿Hay ejemplos en línea / descargables de proyectos de C ++ que […]

Sphinx – tema personalizado no funciona

Tengo configurada la documentación de mi esfinge y quiero usar un tema personalizado. He leído las instrucciones del tema en el sitio web de la esfinge: http://www.sphinx-doc.org/en/stable/theming.html , pero no funciona. Tengo el nombre de mi tema igual que en el archivo conf.py y está en una carpeta zip en el mismo directorio, pero sigo […]

¿Por qué CPython no utiliza `sphinx.autodoc` para la biblioteca estándar?

Estoy desarrollando una biblioteca de python y estoy usando sphinx.autodoc para generar la documentación, ya que creo que esta es una buena forma de no repetirte y de tener documentación y código de acuerdo. ¿En un comentario a Emit reStructuredText de sphinx autodoc? Aprendí que “el proceso de comstackción de CPython docs no tiene habilitado […]

Omita (o formatee) el valor de una variable al documentar con Sphinx

Actualmente estoy documentando un módulo completo con autodoc . Sin embargo, defino varias variables en el nivel del módulo que contienen listas largas o dictados. Se incluyen en la documentación junto con los valores, y los valores están sin formato, por lo que parece un desastre de 10 líneas. Lo que quiero es que se […]