A sphinx extension to generate a rst/markdown to display the dependencies of a python package from requirement.txt
Project description
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 asrequirements/dev.txt
will be converted todev
.template
is a jinja2 file. See jinja2 syntax and examples.
Alternatives
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-requirements-txt-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5375fc48c5b0c6ce0ef232e599ca509ffb986e1ed12269460511eeaeaaeda1e6 |
|
MD5 | b6b38db226bd3009cb4ccbd6db7ae5e7 |
|
BLAKE2b-256 | 150986a2e5de277b58d56e379600f21034fab5fc8df1c29e1f60c82041dce8e2 |
Close
Hashes for sphinxcontrib_requirements_txt-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b312e6ff740407c67b8d79d2b5dcbd8c9109d882bff1cb040e5f585303efd431 |
|
MD5 | cffbd8def186d0496a3e3af73348ca2e |
|
BLAKE2b-256 | caaee795d7562c7514bf1139debba320dc2d6bafea90c132c2665e9dec87f209 |