stsci.sphinxext contiene extensiones a Esfinge para construir la documentación del STScI.
Uso
Estas instrucciones sólo cubren los cambios de las instrucciones estándar Esfinge.
Crear un nuevo árbol de la documentación de la Esfinge, utilizando sphinx_quickstart, tal como se describe en la introducción Esfinge.
Importe las personalizaciones stsci_sphinx en conf.py de su proyecto mediante la inserción de la siguiente línea en la parte superior:
desde stsci.sphinxext.conf import *
La línea de "extensiones" en su conf.py también debe ser modificado por lo que no anula las extensiones definidas por stsci.sphinxext. Por ejemplo, cambie:
extensiones = ['sphinx.ext.autodoc']
a:
extensiones + = ['sphinx.ext.autodoc']
. También, comente la línea 'html_theme', por lo que su proyecto utilizará la stsci.sphinxext uno
Requisitos
- Python
- esfinge
- numpydoc
- Matplotlib
Comentarios que no se encuentran