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.

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

Jump to bottom

Update uses dependencies for sphinx check #9050

Merged
merged 5 commits into from
Nov 5, 2024
Merged

Update uses dependencies for sphinx check #9050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a71e971
Update uses dependencies for sphinx check
kdaily Oct 31, 2024
7e39ee6
Use separate requirements lockfile
kdaily Nov 4, 2024
c6b4b69
Use Python 3.12
kdaily Nov 4, 2024
88945bb
Use GitHub actions version by SHA hash
kdaily Nov 4, 2024
2953926
Update the make check command
kdaily Nov 5, 2024
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
6 changes: 3 additions & 3 deletions .github/workflows/sphinx-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # version 4.2.2
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # version 5.3.0
with:
python-version: "3.10"
python-version: "3.12"
cache: pip
- name: Install dependencies
run: make install
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # version 4.2.2
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # version 5.3.0
with:
python-version: "3.10"
python-version: "3.12"
cache: pip
- name: Install dependencies
run: make install
- name: Build docs
run: make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v0.1.0
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa $ version 3.0.1
with:
path: _build/html
deploy:
Expand All @@ -40,4 +40,4 @@ jobs:
steps:
- name: 'Deploy to GitHub Pages'
id: deployment
uses: actions/deploy-pages@v1.0.4
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # version 4.0.5
7 changes: 4 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ clean:
-rm -rf $(BUILDDIR)/*

install:
$(PYTHON) -m pip install -r requirements.txt
$(PYTHON) -m pip install -r requirements-lock.txt
@echo "Requirements installed"

html:
Expand Down Expand Up @@ -118,7 +118,8 @@ htmlview: html
$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('_build/html/index.html'))"

check:
# Ignore the tools dir and check that the default role is not used.
$(SPHINXLINT) -i tools --enable default-role
# Ignore the static files dir and enable all checks except for `leaked-markup`, which is disabled as there
# are numerous examples displaying markup strings (e.g., backticks).
$(SPHINXLINT) -i _static/files/ --enable all --disable leaked-markup

prcheck: check linkcheck
Loading