From 1f675b184f6777fc5fbdf3df4aff7213459041ca Mon Sep 17 00:00:00 2001 From: Jirka Date: Mon, 15 Aug 2022 22:11:55 +0200 Subject: [PATCH 1/3] CI: clean building docs --- .github/workflows/docs-checks.yml | 7 ++++--- requirements/app/docs.txt | 17 ++++------------- requirements/docs.txt | 13 +++++++++++++ requirements/pytorch/docs.txt | 15 ++------------- setup.py | 2 +- 5 files changed, 24 insertions(+), 30 deletions(-) create mode 100644 requirements/docs.txt diff --git a/.github/workflows/docs-checks.yml b/.github/workflows/docs-checks.yml index 977118b644ef3..5b5a9aec778be 100644 --- a/.github/workflows/docs-checks.yml +++ b/.github/workflows/docs-checks.yml @@ -42,13 +42,13 @@ jobs: - name: Install dependencies env: FREEZE_REQUIREMENTS: 1 + PACKAGE_NAME: ${{ matrix.pkg }} run: | sudo apt-get update sudo apt-get install -y cmake pandoc pip --version - pip install -q fire # python -m pip install --upgrade --user pip - 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 + pip install -e . --quiet -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html pip install -r requirements/${{ matrix.pkg }}/devel.txt pip list shell: bash @@ -91,11 +91,12 @@ jobs: - name: Install dependencies env: FREEZE_REQUIREMENTS: 1 + PACKAGE_NAME: ${{ matrix.pkg }} run: | sudo apt-get update sudo apt-get install -y cmake pandoc pip --version - 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 + pip install -e . --quiet -r requirements/${{ matrix.pkg }}/docs.txt --find-links https://download.pytorch.org/whl/cpu/torch_stable.html # install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux sudo apt-get update && sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures pip list diff --git a/requirements/app/docs.txt b/requirements/app/docs.txt index bf22aef2c2d92..c189d6034ab28 100644 --- a/requirements/app/docs.txt +++ b/requirements/app/docs.txt @@ -1,17 +1,8 @@ -sphinx>=4.0,<5.0 -myst-parser>=0.15,<0.17 -nbsphinx>=0.8.5, <=0.8.9 +-r ../docs.txt + ipython[notebook] ipython_genutils -pandoc>=1.0, <=2.2 -docutils>=0.16, <0.19 -sphinxcontrib-fulltoc>=1.0, <=1.2.0 -sphinxcontrib-mockautodoc +pytorch-lightning -https://storage.googleapis.com/grid-packages/lightning-ai-sphinx-theme/build-31.3.zip -sphinx-autodoc-typehints>=1.0,<1.15 # v1.15 failing on master (#11405) -sphinx-paramlinks>=0.5.1, <=0.5.4 -sphinx-togglebutton>=0.2, <=0.3.2 -sphinx-copybutton>=0.3, <=0.5.0 sphinx-autobuild -jinja2>=3.0.0,<3.1.0 +https://storage.googleapis.com/grid-packages/lightning-ai-sphinx-theme/build-31.3.zip diff --git a/requirements/docs.txt b/requirements/docs.txt new file mode 100644 index 0000000000000..1b00471602c60 --- /dev/null +++ b/requirements/docs.txt @@ -0,0 +1,13 @@ +sphinx>=4.0, <5.0 +myst-parser>=0.15, <0.17 +nbsphinx>=0.8.5, <=0.8.9 +pandoc>=1.0, <=2.2 +docutils>=0.16, <0.19 +sphinxcontrib-fulltoc>=1.0, <=1.2.0 +sphinxcontrib-mockautodoc +sphinx-autodoc-typehints>=1.11, <1.15 # strict; v1.15 failing on master (#11405) +sphinx-paramlinks>=0.5.1, <=0.5.4 +sphinx-togglebutton>=0.2, <=0.3.2 +sphinx-copybutton>=0.3, <=0.5.0 +sphinx-multiproject +jinja2>=3.0.0,<3.1.0 diff --git a/requirements/pytorch/docs.txt b/requirements/pytorch/docs.txt index 50e7c2049f6f6..474620b1e74b8 100644 --- a/requirements/pytorch/docs.txt +++ b/requirements/pytorch/docs.txt @@ -1,17 +1,6 @@ -sphinx>=4.0,<5.0 -myst-parser>=0.15,<0.17 -nbsphinx>=0.8.5, <=0.8.9 +-r ../docs.txt + ipython[notebook] -pandoc>=1.0, <=2.2 -docutils>=0.16, <0.19 -sphinxcontrib-fulltoc>=1.0, <=1.2.0 -sphinxcontrib-mockautodoc pt-lightning-sphinx-theme @ https://github.com/Lightning-AI/lightning_sphinx_theme/archive/master.zip -sphinx-autodoc-typehints>=1.11,<1.15 # strict; v1.15 failing on master (#11405) -sphinx-paramlinks>=0.5.1, <=0.5.4 -sphinx-togglebutton>=0.2, <=0.3.2 -sphinx-copybutton>=0.3, <=0.5.0 -typing-extensions # already in `requirements.txt` but the docs CI job does not install it -jinja2>=3.0.0,<3.1.0 -r ../../_notebooks/.actions/requirements.txt diff --git a/setup.py b/setup.py index 7d4084960d450..519f495c3b041 100755 --- a/setup.py +++ b/setup.py @@ -55,7 +55,7 @@ _PACKAGE_NAME = os.environ.get("PACKAGE_NAME", "") _PACKAGE_MAPPING = {"pytorch": "pytorch_lightning", "app": "lightning_app"} -_REAL_PKG_NAME = _PACKAGE_MAPPING.get(_PACKAGE_NAME, _PACKAGE_NAME) +_REAL_PKG_NAME = _PACKAGE_MAPPING.get(_PACKAGE_NAME, "") # https://packaging.python.org/guides/single-sourcing-package-version/ # http://blog.ionelmc.ro/2014/05/25/python-packaging/ _PATH_ROOT = os.path.dirname(__file__) From e52646677a58bee9f490f4d5ae95c575f788b734 Mon Sep 17 00:00:00 2001 From: Jirka Date: Mon, 15 Aug 2022 22:13:04 +0200 Subject: [PATCH 2/3] group --- .github/checkgroup.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/checkgroup.yml b/.github/checkgroup.yml index 0cb80d6e34bd8..a29deb705295e 100644 --- a/.github/checkgroup.yml +++ b/.github/checkgroup.yml @@ -64,6 +64,7 @@ subprojects: paths: - "docs/source-pytorch/**" - ".github/workflows/docs-*.yml" + - "requirements/docs.txt" - "requirements/pytorch/**" checks: - "doctest (pytorch)" @@ -133,6 +134,7 @@ subprojects: paths: - "docs/source-app/**" - ".github/workflows/docs-*.yml" + - "requirements/docs.txt" - "requirements/app/**" checks: - "doctest (app)" From 4d1454d47547f22e5cc7bc206f3094256371328d Mon Sep 17 00:00:00 2001 From: Jirka Date: Mon, 15 Aug 2022 22:27:14 +0200 Subject: [PATCH 3/3] . --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 519f495c3b041..7d4084960d450 100755 --- a/setup.py +++ b/setup.py @@ -55,7 +55,7 @@ _PACKAGE_NAME = os.environ.get("PACKAGE_NAME", "") _PACKAGE_MAPPING = {"pytorch": "pytorch_lightning", "app": "lightning_app"} -_REAL_PKG_NAME = _PACKAGE_MAPPING.get(_PACKAGE_NAME, "") +_REAL_PKG_NAME = _PACKAGE_MAPPING.get(_PACKAGE_NAME, _PACKAGE_NAME) # https://packaging.python.org/guides/single-sourcing-package-version/ # http://blog.ionelmc.ro/2014/05/25/python-packaging/ _PATH_ROOT = os.path.dirname(__file__)