stsci.sphinxext contém extensões para Sphinx para construir a documentação do STScI.
Uso
Essas instruções só abranger as alterações das instruções padrão Esfinge.
Criar uma nova árvore para a documentação do Sphinx, usando sphinx_quickstart, conforme descrito na introdução Esfinge.
Importar as personalizações stsci_sphinx em conf.py do seu projeto, inserindo a seguinte linha no topo:
stsci.sphinxext.conf de importação *
A linha de "extensões" no seu conf.py também deve ser modificado para que ele não substituir as extensões definidas pelo stsci.sphinxext. Por exemplo, altere:
extensões = ['sphinx.ext.autodoc']
para:
extensões + = ['sphinx.ext.autodoc']
. Além disso, comente a linha 'html_theme', para que o seu projeto usará o stsci.sphinxext um
Requisitos :
- Python
- Sphinx
- numpydoc
- matplotlib
Comentários não encontrado