README.md

sphinxcontrib-requirements-txt

A sphinx extension to generate a rst/markdown to display the dependencies of a python package from requirement.txt.

Usage

Take MyST as an example. rst is similar.

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/title/Namcap>.
git+git://gitlab.archlinux.org/pacman/namcap

docs/conf.py:

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

docs/index.md:

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

Then:

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

A generated markdown will be inserted and rendered. You see:

Customize

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

• /the/path/of/requirements.txt can be a glob expression.
• title can contain {title}, which will be converted to the base name of requirement file. Such as requirements/dev.txt will be converted to dev.
• template is a jinja2 file. See jinja2 syntax and examples.

Alternatives

• sphinxcontrib-eval

See to know more.