stsci.sphinxext 1.2.1

目的

此项目包含sphinx的扩展，用于从stsci构建文档。

先决条件

• Sphinx 0.6.3或更高版本及其依赖项
• numpydoc-支持numpy风格的docstring语法
  • numpy 1.4.0或更高版本附带的版本是必需的
• matplotlib-为内联打印提供matplotlib扩展

这些要求未在 元数据只是因为numpy和matplotlib特别大 很容易处理，所以试图安装狮身人面像主题不应该有 尝试安装这些先决条件的副作用。

用法

这些说明仅涵盖标准狮身人面像的变化 说明。

使用 狮身人面像快速启动，如Sphinx introduction中所述。

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

from stsci.sphinxext.conf import *

还应修改conf.py中的“extensions”行，以便 不重写stsci.sphinxext定义的扩展。为了 例如，更改：

extensions = ['sphinx.ext.autodoc']

致：

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

另外，注释掉“html主题”行，这样您的项目将使用 斯芬克斯一号。