Skjermbilde programvare:
Prog.varedetaljer:
stsci.sphinxext inneholder utvidelser til Sphinx å bygge dokumentasjon fra STScI.
Bruk
Disse instruksjonene dekker kun endringer fra standard Sphinx instruksjoner.
Opprett et nytt tre for din Sphinx dokumentasjon, bruker sphinx_quickstart, som beskrevet i Sphinx innledningen.
Importere stsci_sphinx tilpasninger i prosjektets conf.py ved å sette inn følgende linje på toppen:
fra stsci.sphinxext.conf import *
Den "extensions" linje i conf.py bør også endres slik at den ikke overstyre utvidelser definert av stsci.sphinxext. For eksempel endre:
utvidelser = ['sphinx.ext.autodoc']
til:
utvidelser + = ['sphinx.ext.autodoc']
. Også kommentere ut "html_theme 'linje, slik at prosjektet vil bruke stsci.sphinxext ett
Krav
- Python
- Sphinx
- numpydoc
- Matplotlib
Kommentarer ikke funnet