Skip to content

Commit

Permalink
Documentation: Refactor Sphinx dependencies into setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Oct 30, 2024
1 parent d93e3cd commit c32e8c7
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
fail-fast: false
matrix:
os: ["ubuntu-latest"]
python-version: ["3.11"]
python-version: ["3.12"]

steps:
- uses: actions/checkout@v4
Expand All @@ -31,7 +31,7 @@ jobs:

- name: Install package and documentation dependencies
run: |
uv pip install --system '.[develop]' --requirement=docs/requirements.txt
uv pip install --system '.[develop,docs]'
- name: Run link checker
run: |
Expand Down
5 changes: 4 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ build:

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs

sphinx:
configuration: docs/source/conf.py
Expand Down
7 changes: 6 additions & 1 deletion DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ git clone https://github.com/kennethreitz/responder
cd responder
python3 -m venv .venv
source .venv/bin/activate
pip install --editable '.[graphql,develop,release,test]'
pip install --editable '.[graphql,develop,docs,release,test]'
```

Invoke linter and software tests.
Expand All @@ -20,3 +20,8 @@ Format code.
```shell
poe format
```

Documentation authoring.
```shell
poe docs-autobuild
```
6 changes: 0 additions & 6 deletions docs/requirements.txt

This file was deleted.

4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ def run(self):
"ruff; python_version>='3.7'",
"validate-pyproject",
],
"docs": [
"alabaster<1.1",
"sphinx>=5,<9",
],
"graphql": ["graphene"],
"release": ["build", "twine"],
"test": ["pytest", "pytest-cov", "pytest-mock", "flask"],
Expand Down

0 comments on commit c32e8c7

Please sign in to comment.