在模块文档顶部显示警告，表明它有附加需求。
项目描述
在模块文档顶部显示警告，表明它有附加需求。
文档 |
|
|---|---|
测试 |
|
PyPI |
|
Anaconda |
|
活动 |
|
质量保证 |
|
其他 |
|
概述
此扩展假定您的仓库布局如下
. ├── chemistry_tools │ ├── __init__.py │ ├── formulae │ │ ├── __init__.py │ │ ├── compound.py │ │ ├── formula.py │ │ ├── parser.py │ │ └── requirements.txt │ ├── constants.py │ └── utils.py ├── doc-source │ ├── api │ │ ├── chemistry_tools.rst │ │ ├── elements.rst │ │ ├── formulae.rst │ │ └── pubchem.rst │ ├── conf.py │ ├── index.rst │ └── requirements.txt ├── LICENSE ├── README.rst ├── requirements.txt ├── setup.py └── tox.ini
文件 ./chemistry_tools/formulae/requirements.txt 包含运行 formulae 子包的附加需求。这些在 setup.py 中定义，如下所示
setup(
extras_require={
"formulae": [
"mathematical>=0.1.7",
"pandas>=1.0.1",
"pyparsing>=2.2.0",
"tabulate>=0.8.3",
"cawdrey>=0.1.2",
"quantities>=0.12.4",
],
}
)可以在文档中显示一条消息，表明子包有这些必须安装的附加需求。
例如，这将产生这个
.. extras-require:: formulae
:file: formulae/requirements.txt将生成这个
:file: 中给出的路径相对于在 conf.py 中给出的 package_root 变量，而 conf.py 又相对于Sphinx文档的父目录。
即，此行
package_root = "chemistry_tools"指向 ./chemistry_tools，因此 :file: formulae/requirements.txt 指向 ./chemistry_tools/formulae/requirements.txt。
要求也可以在 pyproject.toml 中指定（使用选项 :pyproject:），setup.cfg（使用选项 :setup.cfg::），或者手动输入，每行一个。
:scope: 选项可用于为附加要求指定不同的范围，例如 package、module、class 或 function。此处可以提供任何字符串值。
安装
extras_require 可以从 PyPI 或 Anaconda 安装。
使用 pip 安装
$ python -m pip install extras_require使用 conda 安装
首先添加所需的通道
$ conda config --add channels https://conda.anaconda.org/conda-forge $ conda config --add channels https://conda.anaconda.org/domdfcoding
然后安装
$ conda install extras_require
通过将“sphinxcontrib.extras_require”添加到 conf.py 中的 extensions 变量来启用 extras_require。
extensions = [
...
"sphinxcontrib.extras_require",
]有关更多信息，请参阅 https://sphinx-doc.cn/en/master/usage/extensions/index.html#third-party-extensions。
链接
下载文件
下载您平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
