stsci.sphinxext 1.2.1

目的

此项目包含Sphinx扩展，用于从STScI构建文档。

先决条件

• Sphinx 0.6.3或更高版本及其依赖项

• numpydoc - 提供对Numpy风格文档字符串语法的支持

  • 需要使用Numpy 1.4.0或更高版本的版本

• matplotlib - 提供了matplotlib的内联绘图扩展

这些要求没有在元数据的安装要求中列出，仅仅是因为numpy和matplotlib特别大且不易处理，因此尝试安装Sphinx主题不应产生尝试安装这些先决条件的副作用。

用法

这些说明仅涵盖从标准Sphinx说明中的更改。

按照Sphinx介绍中所述，使用sphinx_quickstart为您的Sphinx文档创建一个新的目录。

通过在顶部插入以下行将stsci_sphinx自定义导入到项目的conf.py中：

from stsci.sphinxext.conf import *

您的conf.py中的“extensions”行也应进行修改，以便它不覆盖由stsci.sphinxext定义的扩展。例如，将：

extensions = ['sphinx.ext.autodoc']

改为

extensions += ['sphinx.ext.autodoc']

此外，注释掉‘html_theme’行，以便您的项目使用stsci.sphinxext。