Resultados de la búsqueda a petición "python-sphinx"
Dar formato al texto en un enlace en reStructuredText
¿Cómo formatea el texto dentro de un enlace denotado en reStructuredText? Específicamente, deseo generar el siguiente HTML desde mi primer ...
¿Cómo omito los valores de las variables en Sphinx?
Tengo algunas variables de nivel de módulo que tienen valores largos y poco interesantes que me gustaría excluir de la documentación generada automáticamente. ¿Hay alguna forma de hacer esto? Por ejemplo, en mi fuente Python tengo algo ...
¿Ancla en posición arbitraria con sphinx / reStructuredText?
¿Es posible agregar un ancla (destino del enlace, al que me puedo referir con:ref:) en una posición arbitraria en el texto? Tengo una situación como esta: Some text .. class:: mylist **Term 1** Definition *Term 2* Definition :customrole:`Term 3` ...
Utilice el resumen automático de Sphinx de forma recursiva para generar documentación de API
Quiero usar Sphinx'sextensión autosummary [http://www.sphinx-doc.org/en/stable/ext/autosummary.html]yplantillas [http://www.sphinx-doc.org/en/stable/templating.html]para generar documentos API de forma recursiva a partir de cadenas de documentos. ...
Sphinx autodoc no es lo suficientemente automático
Estoy tratando de usar Sphinx para documentar un proyecto de más de 5,000 líneas en Python. Tiene unos 7 módulos base. Hasta donde sé, para usar autodoc necesito escribir código como este para cada archivo en mi proyecto: .. automodule:: ...
Sphinx, manteniendo actualizada la API
El esquema es el siguiente. Existe un paquete llamadofoo (una API en desarrollo pesado, en las primeras fases alfa) cuyorst los archivos se generan automáticamente consphinx-apidoc. En aras de tener una mejor documentación parafoo después de que ...
Esfinge personalización de latexpdf salida?
¿Es curioso si alguien sabe cómo personalizar la salida de la esfinge cuando se utiliza el objetivo latexpdf? He visto muchas cosas personalizadas para la salida html, pero parece que no puedo encontrar ningún ejemplo de salida ...
¿Cómo tengo varias versiones de mi documento con sphinx?
Al igual que la documentación de python o django, ¿cómo tengo varias versiones de mi documento con sphinx? Guardé mi documento en git, y quiero que mi usuario pueda ver la documentación de diferentes versiones comov2.7,v3.4etc. Gracias por la ayuda
¿Puede la función de documento napoleón de la esfinge devolver múltiples argumentos?
Estoy tratando de usar el estilo del código de Google para documentar una función para la que luego uso sphinx con la extensión napoleon para crear documentación. La función es inusual porque devuelve dos argumentos. No creo que Napoleón maneje ...
El módulo automático Sphinx funciona sin conexión pero no a través de readthedocs.org
Parece que no puedo hacer que ReadTheDocs muestre ningún módulo: miembros :, por ejemplo, en mi html local obtengo: MODULE module.Beta(r, theta, beta) evaluates Beta at pointpero después de presionar a github, el documento readthedocs solo ...