stsci.sphinxext conține extensii Sphinx pentru a construi o documentație de la STScI.
Utilizare
Aceste instrucțiuni acoperă doar modificări de la instrucțiunile standard de Sphinx.
Creați un nou copac pentru documentația Sphinx, folosind sphinx_quickstart, așa cum este descris în introducere Sfinxul.
Importa particularizările stsci_sphinx în conf.py proiectul dumneavoastră prin introducerea următoarea linie în partea de sus:
din stsci.sphinxext.conf import *
"Extensii" linia din conf.py dvs. ar trebui să fie, de asemenea, modificat astfel încât să nu suprascrie extensiile definite de stsci.sphinxext. De exemplu, modificați:
extensii = ['sphinx.ext.autodoc']
la:
extensii + = ['sphinx.ext.autodoc']
. De asemenea, comentați linia "html_theme", astfel proiectul va utiliza stsci.sphinxext o
Cerințe :
- python
- Sphinx
- numpydoc
- Matplotlib
Comentariile nu a fost găsit