stsci.sphinxext yra pratęsimus Sfinksas statyti dokumentus iš STScI.
Naudojimas
Šios instrukcijos taikomos tik pokyčius nuo standartinių Sphinx instrukcijas.
Sukurti naują medį savo Sfinksas dokumentus, naudojant sphinx_quickstart, kaip aprašyta Sfinksas įvedimo.
Importuoti stsci_sphinx tinkinimo į savo projekto conf.py įterpiant šią eilutę viršuje:
nuo stsci.sphinxext.conf importo *
"Plėtiniai" linijos savo conf.py taip pat turėtų būti pakeista taip, tai nėra viršesnė pratęsimų apibrėžtus stsci.sphinxext. Pavyzdžiui, pakeisti:
plėtiniai = ['sphinx.ext.autodoc']
į:
plėtiniai + = ['sphinx.ext.autodoc']
. Be to, komentaras iš "html_theme" liniją, kad jūsų projektas bus panaudoti stsci.sphinxext vieną
Reikalavimai
- Pitonas,
- Sfinksas "
- numpydoc
- Matplotlib
Komentarai nerastas