stsci.sphinxext contiene estensioni per Sfinge di costruire la documentazione da STScI.
Utilizzo
Queste istruzioni coprono solo le modifiche delle istruzioni standard Sfinge.
Creare un nuovo albero per la documentazione Sphinx, utilizzando sphinx_quickstart, come descritto in premessa Sfinge.
Importare le personalizzazioni stsci_sphinx nella conf.py del progetto inserendo la seguente riga in alto:
da stsci.sphinxext.conf import *
Il "estensioni" riga nel conf.py dovrebbe essere modificato in modo da non ignorare le estensioni definite da stsci.sphinxext. Ad esempio, modificare:
Estensioni = ['sphinx.ext.autodoc']
a:
Estensioni + = ['sphinx.ext.autodoc']
. Inoltre, commentare la riga 'html_theme', in modo che il progetto utilizzerà il stsci.sphinxext uno
Requisiti
- Python
- Sfinge
- numpydoc
- Matplotlib
I commenti non trovato