Resultados de la búsqueda a petición "python-sphinx"
¿Cómo haría una referencia cruzada de una función generada por autodoc en Sphinx?
Estoy usando elEsfinge autodoc característica para generar documentación basada en las cadenas de documentos de mi biblioteca de Python. Se encuentra la sintaxis para referencias ...
Usando Sphinx con una extensión C creada por distutils
He escrito un módulo de Python que incluye un submódulo escrito en C: el módulo en sí se llamafoo y la parte C esfoo._bar. La estructura se ve así: src/ foo/__init__.py <- contains the public stuff foo/_bar/bar.c <- the C extension doc/ <- ...
RTD: leer los documentos solo importa enlaces y no los contenidos que contiene
Soy muy nuevo para leer los documentos. Tengo una carpeta de documentacióndocsen mi repositorio de github creado usando sphinx en mi máquina local. Traté de vincular los documentos para leer los documentos. Desde la configuración del ...
¿Cómo agregar un archivo CSS personalizado a Sphinx?
¿Cómo puedo agregar un archivo css personalizado? La siguiente configuración no funciona para mí: # conf.py html_static_path = ['_static'] html_theme = 'default' html_theme_options = { 'cssfiles': ['_static/style.css'] ...
Sustitución en Admoniciones
¿Cómo puedo hacer una sustitución en una advertencia? Por ejemplo: |p| account .. note:: **Been using |p| separately and now integrating?**En mi sphinx conf.py defino una regla de reemplazo que se agrega al primer archivo antes de la ...
¿Cuál es la relación entre docutils y Sphinx?
Parece que hay una gran cantidad de herramientas de documentación para Python. Otro que me he encontrado es epydoc. Parece que Sphinx es el estándar de facto, porque se usa para generar los documentos oficiales de Python. ¿Alguien puede resolver ...
¿Qué significa "nivel de título inconsistente"?
He estado recibiendo advertencias en mis compilaciones de documentación de la variedad "Nivel de título inconsistente". Por lo que puedo decir, tengo una estructura consistente que se parece a: Big Title ========= Section ------- Subsection ...
Apidoc Sphinx: no imprima la ruta completa a los paquetes y módulos
Soy bastante nuevo en sphinx y estoy tratando de usarlo como referencia de API para mi proyecto. Quizás después de eso como documentación del proyecto también. Lo genero usando estos dos comandos sphinx-apidoc -e -o doc/api tracer sphinx-build ...
Evite la anidación de subsecciones en Python Sphinx cuando se usa toctree
Me encuentro con un problema al estructurar mi guía de usuario de Sphinx. Me gustaría formar un capítulo teniendo una página de inicio principal (index.rst) que contenga el título del capítulo y una descripción general, y luego subsecciones ...
Cómo documentar paquetes de Python usando Sphinx
Estoy tratando de documentar un paquete en Python. Por el momento tengo la siguiente estructura de directorios: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── ...