Skip to content
Open
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
2 changes: 1 addition & 1 deletion build_sphinx_docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The various steps include:
* installing pip and setting up pip cache
* pip installing build dependencies (themes, build tools, etc.) in one of two ways:
* by default, from `docs/requirements.txt` (with `use-requirements-txt: true`), or
* from the `[docs]` section of `pyproject.toml` (with `use-requirements-txt: false`)
* from the `docs` [dependency group](https://packaging.python.org/en/latest/specifications/dependency-groups/#dependency-groups) in `pyproject.toml` (with `use-requirements-txt: false`)
* checking that external links in the documentation are not broken
* optional, defaults to `true` (i.e. links are checked), see the [warning](#warning) below for more information
* you can pass a GitHub token via the `github-token` input, which is exposed as the `GITHUB_TOKEN` environment variable during linkcheck. This can help avoid rate-limiting when checking links to GitHub repositories.
Expand Down
4 changes: 2 additions & 2 deletions build_sphinx_docs/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ inputs:
type: boolean
default: false
use-requirements-txt:
description: 'Use `docs/requirements.txt` for the docs dependencies. "false" uses [docs] optional dependencies from pyproject.toml'
description: 'Use `docs/requirements.txt` for the docs dependencies. "false" uses the `docs` dependency group from pyproject.toml'
required: false
type: boolean
default: true
Expand Down Expand Up @@ -79,7 +79,7 @@ runs:
if [ ${{ inputs.use-requirements-txt }} == 'true' ]; then
python3 -m pip install -r ./docs/requirements.txt
else
python3 -m pip install ".[docs]"
python3 -m pip install . --group docs
fi

- name: Check links
Expand Down