Skip to content

Remove requirements files and update CI workflow #14

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.

Sign up for GitHub

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

Merged
shenxianpeng merged 4 commits into from
Apr 22, 2026
Merged

Remove requirements files and update CI workflow #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7782c4
Remove requirements files and update CI workflow
shenxianpeng Apr 22, 2026
16ed5e4
docs: update CONTRIBUTING docs dependency instructions
Copilot Apr 22, 2026
7ddb3b4
docs: clarify fallback docs dependency command comments
Copilot Apr 22, 2026
f367d9c
docs: fix mkdocs get-deps install command in CONTRIBUTING
Copilot Apr 22, 2026
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
8 changes: 4 additions & 4 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ jobs:
with:
python-version: '3.11'
- name: Install dependencies
run: pip install --no-deps -r requirements/requirements-docs.txt
run: pip install hatch
- name: Build site
run: mkdocs build --strict
run: hatch run docs:build
Comment thread
shenxianpeng marked this conversation as resolved.
Comment on lines +18 to +20
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By switching the docs job from a fully pinned requirements-docs.txt install to hatch run docs:build, the versions of the docs build toolchain become implicit and may drift over time, which can make scheduled builds/deploys flaky. If reproducible docs builds are desired, consider introducing a lock/pin mechanism for the docs environment (e.g., pin key docs plugins in Hatch env deps, or adopt a lock file approach) to replace the removed requirements file.

Copilot uses AI. Check for mistakes.

deploy:
runs-on: ubuntu-latest
Expand All @@ -33,6 +33,6 @@ jobs:
with:
python-version: '3.11'
- name: Install dependencies
run: pip install --no-deps -r requirements/requirements-docs.txt
run: pip install hatch
- name: Deploy to GitHub Pages
run: mkdocs gh-deploy --force
run: hatch run docs:deploy
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,11 @@ hatch run lint:check

If you add a new plugin to mkdocs.yml, you don't need to add it to any "requirements" file, because that is managed automatically.

> INFO: If you don't want to use Hatch, for documentation you can install requirements into a virtualenv, in one of these ways (with `.venv` being the virtualenv directory):
> INFO: If you don't want to use Hatch, for documentation you can install dependencies into a virtualenv (with `.venv` being the virtualenv directory):
>
> ```bash
> .venv/bin/pip install -r requirements/requirements-docs.txt # Exact versions of dependencies.
> .venv/bin/pip install -r $(mkdocs get-deps) # Latest versions of all dependencies.
> .venv/bin/pip install --editable .
> .venv/bin/pip install $(mkdocs get-deps) # Additional dependencies from mkdocs.yml plugins/themes.
> ```

## Translating themes
Expand Down
4 changes: 1 addition & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ dependencies = [
]

[tool.hatch.env]
requires = ["hatch-mkdocs", "hatch-pip-compile"]
requires = ["hatch-mkdocs"]

[tool.hatch.envs.default.scripts]
all = [
Expand Down Expand Up @@ -169,7 +169,6 @@ dependencies = [
check = "mypy mkdocs"

[tool.hatch.envs.style]
type = "pip-compile"
detached = true
dependencies = [
"black",
Expand Down Expand Up @@ -208,7 +207,6 @@ check = ["markdown", "js", "css", "spelling"]
[tool.hatch.env.collectors.mkdocs.docs]
path = "mkdocs.yml"
[tool.hatch.envs.docs]
type = "pip-compile"
detached = false

[tool.black]
Expand Down
134 changes: 0 additions & 134 deletions requirements/requirements-docs.txt
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions requirements/requirements-style.txt
View file
Open in desktop

This file was deleted.

Loading