sphinxcontrib-requirements-txt

一个用于从 requirement.txt 生成 rst/markdown 以显示 Python 包依赖项的 Sphinx 扩展。

使用方法

以 MyST 为例。rst 类似。

requirement.txt:

# To complete package names, a cache is needed.
# Every time you change template, the cache must be regenerated.
#
# ```shell
# $ pkgbuild-language-server --print-config cache
# /home/wzy/.cache/pacman.json
# ```

pyalpm
# See <https://wiki.archlinux.org.cn/title/Namcap>.
git+git://gitlab.archlinux.org/pacman/namcap

docs/conf.py:

# ...
extensions = [
    "myst_parser",
    "sphinxcontrib.requirements_txt",
]
# ...

docs/index.md:

```{requirements} ../requirements.txt
```

然后

cd docs && sphinx-build . _build/html
cd -
xdg-open docs/_build/html/index.html

生成的 markdown 将被插入并渲染。您可以看到

自定义

```{requirements} /the/path/of/requirements.txt
---
title: Dependence
template: /the/path/of/template.j2
---
```

• /the/path/of/requirements.txt 可以是一个 glob 表达式。
• title 可以包含 {title}，它将被转换为 requirement 文件的基本名称。例如，requirements/dev.txt 将转换为 dev。
• template 是一个 jinja2 文件。参见 jinja2 语法 和 示例。

替代方案

• sphinxcontrib-eval

查看 了解更多信息。