Skip to content

Commit ecc7aab

Browse files
authored
docs: Enable NumPy hyperlinks and install less stuff in check_docs workflow (#18)
* docs: Add intersphinx hyperlinks for NumPy * docs: Don't install lint/test dependencies
1 parent 758924a commit ecc7aab

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

.github/workflows/check_docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
path: .venv
3333
key: nitypes-with-docs-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
3434
- name: Install nitypes (with docs)
35-
run: poetry install -v --with docs
35+
run: poetry install -v --only main,docs
3636
- name: Generate docs
3737
run: poetry run sphinx-build docs docs/_build -b html -W --keep-going
3838
- name: Upload docs artifact

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ def setup(sphinx):
7474

7575

7676
intersphinx_mapping = {
77+
"numpy": ("https://numpy.org/doc/stable/", None),
7778
"python": ("https://docs.python.org/3", None),
7879
}
7980

0 commit comments

Comments
 (0)