Skip to content

Commit 9237eda

Browse files
committed
CI: clean building docs (#14216)
* CI: clean building docs * group * .
1 parent e2c50ec commit 9237eda

File tree

5 files changed

+25
-29
lines changed

5 files changed

+25
-29
lines changed

.github/checkgroup.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ subprojects:
6464
paths:
6565
- "docs/source-pytorch/**"
6666
- ".github/workflows/docs-*.yml"
67+
- "requirements/docs.txt"
6768
- "requirements/pytorch/**"
6869
checks:
6970
- "doctest (pytorch)"
@@ -133,6 +134,7 @@ subprojects:
133134
paths:
134135
- "docs/source-app/**"
135136
- ".github/workflows/docs-*.yml"
137+
- "requirements/docs.txt"
136138
- "requirements/app/**"
137139
checks:
138140
- "doctest (app)"

.github/workflows/docs-checks.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ jobs:
4242
- name: Install dependencies
4343
env:
4444
FREEZE_REQUIREMENTS: 1
45+
PACKAGE_NAME: ${{ matrix.pkg }}
4546
run: |
4647
sudo apt-get update
4748
sudo apt-get install -y cmake pandoc
4849
pip --version
49-
pip install -q fire
5050
# python -m pip install --upgrade --user pip
51-
pip install -e . --quiet -r requirements/${{ matrix.pkg }}/base.txt -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html
51+
pip install -e . --quiet -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html
5252
pip install -r requirements/${{ matrix.pkg }}/devel.txt
5353
pip list
5454
shell: bash
@@ -91,11 +91,12 @@ jobs:
9191
- name: Install dependencies
9292
env:
9393
FREEZE_REQUIREMENTS: 1
94+
PACKAGE_NAME: ${{ matrix.pkg }}
9495
run: |
9596
sudo apt-get update
9697
sudo apt-get install -y cmake pandoc
9798
pip --version
98-
pip install -e . --quiet -r requirements/${{ matrix.pkg }}/base.txt -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html
99+
pip install -e . --quiet -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html
99100
# install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
100101
sudo apt-get update && sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures
101102
pip list

requirements/app/docs.txt

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
1-
sphinx>=4.0,<5.0
2-
myst-parser>=0.15,<0.17
3-
nbsphinx>=0.8.5, <=0.8.9
1+
-r ../docs.txt
2+
43
ipython[notebook]
54
ipython_genutils
6-
pandoc>=1.0, <=2.2
7-
docutils>=0.16, <0.19
8-
sphinxcontrib-fulltoc>=1.0, <=1.2.0
9-
sphinxcontrib-mockautodoc
5+
pytorch-lightning
106

11-
https://storage.googleapis.com/grid-packages/lightning-ai-sphinx-theme/build-31-rc1.zip
12-
sphinx-autodoc-typehints>=1.0,<1.15 # v1.15 failing on master (#11405)
13-
sphinx-paramlinks>=0.5.1, <=0.5.4
14-
sphinx-togglebutton>=0.2, <=0.3.2
15-
sphinx-copybutton>=0.3, <=0.5.0
167
sphinx-autobuild
17-
jinja2>=3.0.0,<3.1.0
8+
https://storage.googleapis.com/grid-packages/lightning-ai-sphinx-theme/build-31.3.zip

requirements/docs.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
sphinx>=4.0, <5.0
2+
myst-parser>=0.15, <0.17
3+
nbsphinx>=0.8.5, <=0.8.9
4+
pandoc>=1.0, <=2.2
5+
docutils>=0.16, <0.19
6+
sphinxcontrib-fulltoc>=1.0, <=1.2.0
7+
sphinxcontrib-mockautodoc
8+
sphinx-autodoc-typehints>=1.11, <1.15 # strict; v1.15 failing on master (#11405)
9+
sphinx-paramlinks>=0.5.1, <=0.5.4
10+
sphinx-togglebutton>=0.2, <=0.3.2
11+
sphinx-copybutton>=0.3, <=0.5.0
12+
sphinx-multiproject
13+
jinja2>=3.0.0,<3.1.0

requirements/pytorch/docs.txt

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
sphinx>=4.0,<5.0
2-
myst-parser>=0.15,<0.17
3-
nbsphinx>=0.8.5, <=0.8.9
1+
-r ../docs.txt
2+
43
ipython[notebook]
5-
pandoc>=1.0, <=2.2
6-
docutils>=0.16, <0.19
7-
sphinxcontrib-fulltoc>=1.0, <=1.2.0
8-
sphinxcontrib-mockautodoc
94
pt-lightning-sphinx-theme @ https://github.com/Lightning-AI/lightning_sphinx_theme/archive/master.zip
10-
sphinx-autodoc-typehints>=1.11,<1.15 # strict; v1.15 failing on master (#11405)
11-
sphinx-paramlinks>=0.5.1, <=0.5.4
12-
sphinx-togglebutton>=0.2, <=0.3.2
13-
sphinx-copybutton>=0.3, <=0.5.0
14-
typing-extensions # already in `requirements.txt` but the docs CI job does not install it
15-
jinja2>=3.0.0,<3.1.0
165

176
-r ../../_notebooks/.actions/requirements.txt

0 commit comments

Comments
 (0)