Merge docs-requirements.txt into pyproject.toml

Keep requirements definitions all in one place.
This commit is contained in:
Hugo Osvaldo Barrera 2025-09-20 13:17:56 +02:00
parent a4ceabf80b
commit a9b6488dac
5 changed files with 13 additions and 10 deletions

View file

@ -12,4 +12,5 @@ python:
install: install:
- method: pip - method: pip
path: . path: .
- requirements: docs-requirements.txt extra_requirements:
- docs

View file

@ -49,8 +49,8 @@ release-deb:
install-dev: install-dev:
pip install -U pip setuptools wheel pip install -U pip setuptools wheel
pip install -e '.[test]' pip install -e '.[test,docs]'
pip install -U -r docs-requirements.txt pre-commit pip install -U pre-commit
set -xe && if [ "$(REQUIREMENTS)" = "minimal" ]; then \ set -xe && if [ "$(REQUIREMENTS)" = "minimal" ]; then \
pip install pyproject-dependencies && \ pip install pyproject-dependencies && \
pip install -U --force-reinstall $$(pyproject-dependencies . | sed 's/>/=/'); \ pip install -U --force-reinstall $$(pyproject-dependencies . | sed 's/>/=/'); \

View file

@ -1,4 +0,0 @@
# This file is used by readthedocs.org
sphinx != 1.4.7
sphinx_rtd_theme
setuptools_scm

View file

@ -74,10 +74,11 @@ Using Sphinx_ you can generate the documentation you're reading right now in a
variety of formats, such as HTML, PDF, or even as a manpage. That said, I only variety of formats, such as HTML, PDF, or even as a manpage. That said, I only
take care of the HTML docs' formatting. take care of the HTML docs' formatting.
You can find a list of dependencies in ``docs-requirements.txt``. Again, you You can find a list of dependencies in ``pyproject.toml``, in the
can install those using pip with:: ``project.optional-dependencies`` section as ``docs``. Again, you can install
those using pip with::
pip install -r docs-requirements.txt pip install '.[docs]'
Then change into the ``docs/`` directory and build whatever format you want Then change into the ``docs/`` directory and build whatever format you want
using the ``Makefile`` in there (run ``make`` for the formats you can build). using the ``Makefile`` in there (run ``make`` for the formats you can build).

View file

@ -53,6 +53,11 @@ test = [
"pytest-asyncio", "pytest-asyncio",
"aioresponses", "aioresponses",
] ]
docs = [
"sphinx!=1.4.7",
"sphinx_rtd_theme",
"setuptools_scm",
]
[project.scripts] [project.scripts]
vdirsyncer = "vdirsyncer.cli:app" vdirsyncer = "vdirsyncer.cli:app"