python-sphinx

5El calor

2Respuesta

sphinx.ext.autodoc: Mantener los nombres de las constantes en la firma

Estoy usando la función autodoc de Sphinx para documentar mi API. Ejemplo: DEFAULT_OPTION = 'default' def do_something(msg, option=DEFAULT_OPTION): print msg La documentación generada ahora mu

python python-sphinx 2011-08-29

---

9El calor

1Respuesta

Incluyendo docstring en Sphinx Documentation

Me gustaría incluir solo el docstring de una función específica en mi documentación de Sphinx. Sin embargo, parece que no hay opciones para mostrar estos detalles sin definiciones de clases y funcione

python python-sphinx autodoc 2011-10-19

---

5El calor

1Respuesta

Cómo generar resultados tabulares en reStructuredText sin usar el formato de tabla RST?

Estoy tratando de migrar nuestros documentos API y su esquema generador de documentación propietario a reStructuredText. La pieza que da el tiempo más difícil es que tenemos una representación tabular

documentation documentation-generation python-sphinx restructuredtext docutils 2011-10-19

---

7El calor

2Respuesta

Formato de punto flotante Sphinx

Estoy usando Sphinx para generar documentación del código. ¿Alguien sabe si hay una forma de controlar el formateo de los números de coma flotante generados a partir de los argumentos predeterminados?

python formatting python-sphinx 2011-08-31

---

5El calor

2Respuesta

Sphinx, literalinclude, linenos: ¿Cómo mostrar los números de línea reales del archivo de código fuente en el fragmento de código del documento?

Estoy usando Sphinx para documentar partes de código JavaScript en una página web. utilizo .. literalinclude:: ../examples/mapviz-step1-simple.html :language: javascript :lines: 47-51 :

python-sphinx 2011-07-29

---

13El calor

1Respuesta

Python de documento utilizando Eclipse/Pydev

Soy nuevo en el desarrollo de Python y uso Eclipse/Pydev. ¿Existe alguna manera de integrar herramientas para generar documentaciones (por ejemplo, Sphinx, pydoc) en el IDE para tener un buen flujo de

python eclipse pydev python-sphinx pydoc 2011-08-03

---

5El calor

1Respuesta

¿Cómo puedo hipervincular un método desde un módulo de Python en Sphinx?

Al escribir la documentación usando Sphinx, sé que puedo enlazar a una clase mediante Intersphinx: :py:class:`logging.Logger` Pero ¿Cómo se enlazan directamente a un método específico, como logging.

python python-sphinx 2011-08-05

---

7El calor

1Respuesta

Análisis de archivos .rst con directivas específicas de Sphinx mediante programación

Me gustaría poder analizar primero la base de sphinx en Python para su posterior procesamiento y comprobación. Algo así como: import sphinx p = sphinx.parse("/path/to/file.rst") do_something_with(p)

python python-sphinx docutils 2011-11-14

---

6El calor

1Respuesta

¿Cómo puedo agregar un prólogo o un prefacio antes del TOC en un documento de esfinge (pdflatex)?

¿Cómo puedo usar Sphinx para generar un documento pdflatex en el que hay algún texto antes de la tabla de contenido? El archivo LaTeX generado siempre parece tener \tableofcontents antes de cualquier

python-sphinx pdflatex 2011-09-26

---

8El calor

2Respuesta

¿Alguna buena alternativa para Sphinx para proporcionar documentación de software?

me preguntaba si hay alguna buena alternativa a Sphinx cuando quiero proporcionar documentación html estática para proyectos de software. Sphinx parece estar bien, pero se usa principalmente en el áre

documentation python-sphinx gollum-wiki 2011-08-19

---