Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEP: move docs requirements to a PEP 735 dependency group #424

Merged
merged 1 commit into from
Jan 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,9 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: astral-sh/setup-uv@887a942a15af3a7626099df99e897a18d9e5ab3a # v5.1.0
- name: Setup env
run: |
uv venv
uv pip install -r docs/requirements.txt
run: uv sync --frozen --group docs
- name: Build
run: |
uv run mkdocs build
run: uv run mkdocs build
- name: Upload artifacts
uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
with:
Expand Down
11 changes: 6 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ build:
os: ubuntu-22.04
tools:
python: '3'
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv sync --frozen --group docs
- uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 0 additions & 8 deletions docs/requirements.in

This file was deleted.

117 changes: 0 additions & 117 deletions docs/requirements.txt

This file was deleted.

6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ typecheck = [
"mypy>=1.11.2",
"pyright>=1.1.390",
]
docs = [
"mkdocs>=1.5.3",
"mkdocs-include-markdown-plugin>=6.0.1",
"mkdocs-material>=9.4.2",
"mkdocstrings[python]>=0.23.0",
]

[tool.hatch.build.targets.sdist]
exclude = [
Expand Down
Loading
Loading