Articles of python sphinx

Cómo documentar paquetes de Python usando Sphinx

Estoy tratando de documentar un paquete en Python. En este momento tengo la siguiente estructura de directorios: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── Makefile ├── mod1 │ ├── foo.py │ └── __init__.py ├── mod2 │ […]

‘Título de sección inesperado’ con Sphinx: ¿es el problema el problema?

Cuando se ejecuta sphinx-build . html/ en mi directorio doc/ , obtengo el siguiente resultado: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using default: html loading pickled environment… done building [html]: targets for 0 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sources… [100%] […]

django sphinx automodule – conceptos básicos

Tengo un proyecto con varias aplicaciones grandes y donde se dividen los archivos de configuración y aplicaciones. La estructura del directorio es algo así: nombre del proyecto __init__.py aplicaciones __init__.py app1 app2 Tercera parte __init__.py lib1 lib2 ajustes __init__.py Install_apps.py path.py templates.py locale.py … urls.py cada aplicación es así __init__.py administración __init__.py file1.py file2.py modelos […]

Sustituciones en bloques de código Sphinx

En este ejemplo de reST destinado a ser traducido por Sphinx, | yaco_url | no se reemplaza porque está en un bloque de código: .. |yaco_url| replace:: http://yaco.es/ You can use wget to download it: .. code-block:: console $ wget |yaco_url|package.tar.gz Me pregunto si hay alguna manera de forzar el reemplazo de | yaco_url | […]

¿Cómo preprocesar los archivos de origen mientras se ejecuta un Sphinx?

He configurado una documentación de Sphinx para mi proyecto y me gustaría extraer cadenas de documentos para los archivos de origen e incrustarlos en la documentación final. Desafortunadamente, el idioma del archivo fuente (VHDL) no es compatible con Sphinx. Parece que no hay un dominio Sphinx para VHDL. Así que mis ideas son las siguientes: […]

Resumen de Sphinx “toctree contiene referencias a documentos no existentes” advertencias

Estoy tratando de crear automáticamente api docs para una gran base de código de Python usando Sphinx. He intentado usar build_modules.py y sphinx-apidoc. Con cualquiera de los dos, puedo hacer que los primeros documentos se creen correctamente en mi directorio de salida para los paquetes y los módulos de nivel superior. Sin embargo, cuando construyo […]

Agregar una etiqueta de script javascript en algún lugar para que funcione con cada archivo en la documentación de sphinx

Estoy usando Sphinx para escribir algunas notas. Estoy usando la extensión Mathjax para Matemáticas en las notas. El tamaño predeterminado de las matemáticas es un poco más grande de lo que me gustaría. En la página de Mathjax encontré que puedo cambiar ese tamaño agregando el siguiente script al archivo HTML. MathJax.Hub.Config({ “HTML-CSS”: {scale: 90} […]

Referencia a parámetros en una cadena de documentación de Python

Uso Sphinx y la función de autodocs para asegurar que tengamos buena documentación en nuestro proyecto. Así que estoy familiarizado con las listas de campos de información y estoy familiarizado con el uso de referencias cruzadas en nuestros documentos. Sin embargo, cuando escribo docstring para un método o función, me parece útil referirme a sus […]

Esfinge con formato de punto flotante

Estoy usando Sphinx para generar documentación desde el código. Alguien sabe si hay una manera de controlar el formato de los números de punto flotante generados a partir de los argumentos predeterminados. Por ejemplo si tengo la siguiente función: def f(x = 0.97): return x+1 La documentación generada termina pareciéndose a: foo(x = 0.96999999999997) Obviamente, […]

¿Cómo documentar clases anidadas con autodoc de Sphinx?

¿Hay alguna forma de documentar una clase anidada con el complemento autodoc de Sphinx? En: class A: class B: “”” class B’s documentation. “”” # … Quiero usar autoclass o algo similar en mi archivo .rst para documentar AB específicamente. Lo intenté: .. currentmodule:: package.module .. autoclass:: AB y .. autoclass:: package.module.AB sin éxito: /path/to/file.rst:280: […]