Articles of documentación de

sphinx-build fail – autodoc no puede importar / encontrar módulo

Estoy tratando de comenzar con Sphinx y parece tener problemas implacables. Comando: docs/sphinx-quickstart Respondo a todas las preguntas y todo funciona bien. Comando: docs/ls Todo se ve normal. Resultado: build Makefile source Comando: sphinx-build -d build/doctrees source build/html Parece funcionar. Pude abrir el archivo index.html y ver un “shell” de lo que quiero. Cuando bash […]

Salida condicional en la documentación de Sphinx

Estoy escribiendo alguna documentación con Sphinx y me gustaría imprimir un cierto bloque de texto solo para la documentación HTML, no para la documentación LaTeX. Algo me dice que debería poder hacer esto con sphinx.ext.ifconfig pero no sé cómo. ¿Alguien sabe como hacer esto?

¿Por qué los documentos de la función de Python incluyen la coma después del corchete para argumentos opcionales?

El formato de las firmas de funciones en los documentos de Python es un poco confuso. ¿Cuál es el significado de poner la coma después del corchete abierto, en lugar de antes? ¿Cuál es el significado de anidar los soportes? Como son RegexObject.match(string[, pos[, endpos]]) Yo esperaría uno de los siguientes: RegexObject.match(string, [pos], [endpos]) RegexObject.match(string[, […]

Cómo documentar el código de Python con doxygen

Me gusta doxygen para crear documentación de código C o PHP. Tengo un proyecto próximo de Python y creo que recuerdo que Python no tiene /* .. */ comments, y también tiene su propia función de autodocumentación, que parece ser la forma en que se documentan los pitones. Ya que estoy familiarizado con doxygen, ¿cómo […]

¿Qué es esta opción “generada” en la directiva de resumen automático de Sphinx?

Estoy usando sphinx api-doc y las extensiones de resumen automático para documentar una API para una biblioteca y realmente no puedo entender el propósito de la opción generated/ continuación: .. autosummary:: :nosignatures: :toctree: generated/ module.function_1 module.function_2 … He visto que esto es la documentación de la esfinge, y en bibliotecas como pandas. Estoy usando toctree […]

Cómo usar Python para generar mediante progtwigción parte de la documentación de Sphinx

Estoy usando Sphinx para generar la documentación de un proyecto mío. En este proyecto, describo una lista de comandos disponibles en un archivo yaml que, una vez cargado, da como resultado un diccionario en la forma {command-name : command-description} por ejemplo: commands = {“copy” : “Copy the highlighted text in the clipboard”, “paste” : “Paste […]

Heredar cadenas de documentos en la herencia de la clase Python

Estoy tratando de hacer alguna herencia de clase en Python. Me gustaría que cada clase y clase heredada tenga buenas cadenas de documentación. Así que creo que para la clase heredada, me gustaría que: heredar el docstring clase base tal vez adjunte documentación adicional relevante a la cadena de documentación ¿Hay alguna forma (posiblemente elegante […]

Usando javadoc para la documentación de Python

Actualmente estoy empezando con Python y tengo una sólida formación en PHP y en PHP he tomado el hábito de usar javadoc como plantilla de documentación. Me preguntaba si javadoc tiene su lugar como documentación de documentación en Python. ¿Cuáles son las convenciones establecidas y / o líneas oficiales aquí? Por ejemplo, ¿algo como esto […]

¿Qué hace% a las cadenas en Python?

No he podido encontrar la documentación para el operador% cuando se usa en cadenas en Python. ¿Alguien sabe dónde está esa documentación?

Anular la statement de función en autodoc para esfinge

Tengo un módulo que va algo como esto: #!/usr/bin/env python #: Documentation here. #: blah blah blah foobar = r’Some really long regex here.’ def myfunc(val=foobar): ”’Blah blah blah”’ pass … y tengo un archivo .rst que dice algo así: :mod:`my_module` Module ———————– ..automodule:: my_module :members: :private-members: :show-inheritance: Cuando compilo la documentación, obtengo un archivo […]