针对Astropy项目的Sphinx扩展和配置
项目描述
此软件包有两个用途:它提供针对Astropy项目的默认Sphinx配置和一组特定扩展,并作为元软件包安装核心Astropy软件包和其他软件包所需的全部Sphinx扩展。
Sphinx配置
默认的 Sphinx 配置可以通过在您的 conf.py 文件顶部添加以下内容来导入:
from sphinx_astropy.conf import *
然后您可以从默认配置中覆盖特定的设置,例如添加扩展或 intersphinx 包。为了为用户提供更清晰的错误消息,您也可以编写:
try:
from sphinx_astropy.conf import *
except ImportError:
print('ERROR: the documentation requires the sphinx-astropy package to be installed')
sys.exit(1)
依赖项/扩展
安装 sphinx-astropy 将自动安装(如果尚未安装)
astropy-sphinx-theme - Astropy 及其多个关联包使用的默认 'bootstrap' 主题。这配合 sphinx_astropy.conf.v1 使用。
sphinx-automodapi - 一个扩展,可以轻松地自动生成 API 文档。
sphinx-gallery - 一个用于生成示例画廊的扩展
numpydoc - 一个用于解析 NumpyDoc 格式文档字符串的扩展
pillow - 一个用于处理图像的包,被 astropy 核心文档中的某些示例使用。
pytest-doctestplus - 提供 'doctestplus' 扩展以在叙事文档中跳过代码片段。
pydata-sphinx-theme (confv2)
要使用新的 pydata-sphinx-theme 与 sphinx_astropy.conf.v2,您必须安装可选的 [confv2] 依赖项
pip install sphinx-astropy[confv2]
这将自动引入以下依赖项
pydata-sphinx-theme - 由 PyData 社区开发和使用的一个干净、三列、基于 Bootstrap 的 Sphinx 主题。
sphinx-copybutton - 一个小的 Sphinx 扩展,用于向代码块添加“复制”按钮。
项目详情
下载文件
下载您平台上的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。
源代码分发
构建分发
sphinx-astropy-1.9.1.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7931c795f445caee38f98754afd75fe7393db7df2c4dcc860f94a011fb162454 |
|
MD5 | da84468f9a8395216a22f8bdf292d43b |
|
BLAKE2b-256 | 18ee957984621943eaa47497be959cc6695ae775745525e5fe9d4ff8174678cc |
sphinx_astropy-1.9.1-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 0a6be6addb511c3d83647763608ef4fb9254dbc25ae04504837b3b1139c4b130 |
|
MD5 | 17a3461855bed0edf37e84796f11cfd2 |
|
BLAKE2b-256 | 4add1487887b8fc3be42fb0cf896f4683ea1d21035485407498e5c1d51325987 |