跳转到主要内容

针对Astropy项目的Sphinx扩展和配置

项目描述

Zenodo DOI CI Status

此软件包有两个用途:它提供针对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 将自动安装(如果尚未安装)

  • Sphinx

  • 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-themesphinx_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 (19.3 kB 查看哈希值)

上传日期 源代码

构建分发

sphinx_astropy-1.9.1-py3-none-any.whl (23.8 kB 查看哈希值)

上传日期 Python 3

支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面