python-sphinx

10El calor

1Respuesta

Omitir (o formatear) 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 de módulo que contienen largas listas o dicts. Se incluyen en la documentación junto con

python documentation python-sphinx 2012-06-02

---

22El calor

3Respuesta

Sphinx y argparse - autodocumentación de scripts de línea de comando?

Estoy compilando un paquete de Python y utilizando Sphinx para crear los documentos. Aparte de mi código de paquete, también incluyo una gran cantidad de scripts de Python de línea de comando, que usa

python documentation python-sphinx argparse 2012-06-04

---

52El calor

5Respuesta

¿Puede esfinge el enlace a documentos que no están ubicados en directorios debajo del documento raíz?

Estoy usando Sphinx para documentar un proyecto que no es de Python. Quiero distribuir las carpetas ./doc en cada submódulo, que contiene submodule_name.rst archivos para documentar ese módulo. Luego

python python-sphinx 2012-04-17

---

44El calor

1Respuesta

La instalación reciente de sphinx-quickstart falla

Tratando de que funcione con Sphinx por primera vez, con una instalación limpia de Sphinx 1.1.3, y shinx-quickstart falla. ¿Debería haber alguna dependencia instalada? Traté de pip --force-reinstall s

python-sphinx 2012-06-06

---

13El calor

3Respuesta

Rejilla de imagen en reStructuredText/Sphinx

Estoy usando Sphinx para crear documentación para un proyecto de Python en el que estoy trabajando. Tengo tres imágenes que me gustaría mostrar en una cuadrícula de 1x3 (es decir, todas en la misma lí

python python-sphinx restructuredtext 2012-04-18

---

50El calor

7Respuesta

esfinge acumulación falle - autodoc no puede importar/encontrar el módulo

que estoy tratando de empezar a trabajar con la esfinge y parecen tener problemas implacables. Comando: docs/sphinx-quickstart contesto todas las preguntas y todo funciona bien. Comando: docs/ls todo

python documentation python-sphinx 2012-04-25

---

5El calor

1Respuesta

Documentación de la API pública de Sphinx

Tengo una gran cantidad de archivos python y me gustaría generar documentación API pública para mi proyecto. Todas las funciones que son parte de la API que he decorado con un decorador. por ejemplo:

python documentation python-sphinx 2012-04-27

---

13El calor

3Respuesta

Alojamiento privado Documentación Sphinx

Actualmente estoy escribiendo algunos extensa documentación mediante la esfinge por un sitio web bastante complejo Django. He estado trabajando en esto en la casa y antes de que salga pronto quiero de

django python-sphinx 2012-06-19

---

6El calor

1Respuesta

¿Por qué CPython no usa `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 manera de no repetirse y tener la documentación y el código d

python documentation python-sphinx 2012-05-09

---

9El calor

2Respuesta

Manera más simple de ejecutar Sphinx en un archivo de Python

Tenemos una configuración de Sphinx que generará una gran cantidad de documentos HTML para todo nuestro código base. A veces, estoy trabajando en un archivo y me gustaría ver el resultado HTML de ese

python python-sphinx 2012-05-21

---