From 766b314f80d043e2666fc1cebabad337f96a5ee7 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Thu, 29 Feb 2024 16:56:11 -0700 Subject: [PATCH 1/4] Update documentation requirements and configuration for ReadtheDocs Change-Id: I9e6fb081a6e386523708d6ce9e3d9b1b6e6665b9 --- amd/hipcc/.readthedocs.yaml | 2 +- amd/hipcc/docs/sphinx/requirements.in | 2 +- amd/hipcc/docs/sphinx/requirements.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/amd/hipcc/.readthedocs.yaml b/amd/hipcc/.readthedocs.yaml index 9b26b6862b8d51..605b184ac193eb 100644 --- a/amd/hipcc/.readthedocs.yaml +++ b/amd/hipcc/.readthedocs.yaml @@ -4,7 +4,7 @@ version: 2 sphinx: - configuration: docs/conf.py + configuration: amd/hipcc/docs/conf.py formats: [htmlzip, pdf, epub] diff --git a/amd/hipcc/docs/sphinx/requirements.in b/amd/hipcc/docs/sphinx/requirements.in index 2dc317aca672db..0a6d69d8e06251 100644 --- a/amd/hipcc/docs/sphinx/requirements.in +++ b/amd/hipcc/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.31.0 +rocm-docs-core>=0.35.0 diff --git a/amd/hipcc/docs/sphinx/requirements.txt b/amd/hipcc/docs/sphinx/requirements.txt index e53dd358283447..d7a2ca2dab42be 100644 --- a/amd/hipcc/docs/sphinx/requirements.txt +++ b/amd/hipcc/docs/sphinx/requirements.txt @@ -100,7 +100,7 @@ requests==2.28.2 # via # pygithub # sphinx -rocm-docs-core==0.31.0 +rocm-docs-core>=0.35.0 # via -r requirements.in smmap==5.0.0 # via gitdb From 55969718fb4c34e80c434dfb3aee49dff93715f7 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Wed, 12 Jun 2024 15:15:11 -0600 Subject: [PATCH 2/4] [ROCDOC-593] Update Read the Docs configuration to Python 3.10 and latest rocm-docs-core for HIPCC documentation Change-Id: I1cf7860e268815137d004f0ea670384296247620 --- amd/hipcc/.readthedocs.yaml | 2 +- amd/hipcc/docs/sphinx/requirements.in | 2 +- amd/hipcc/docs/sphinx/requirements.txt | 118 ++++++++++++------------- 3 files changed, 58 insertions(+), 64 deletions(-) diff --git a/amd/hipcc/.readthedocs.yaml b/amd/hipcc/.readthedocs.yaml index 605b184ac193eb..173be2324e82d0 100644 --- a/amd/hipcc/.readthedocs.yaml +++ b/amd/hipcc/.readthedocs.yaml @@ -15,4 +15,4 @@ python: build: os: ubuntu-22.04 tools: - python: "3.8" + python: "3.10" diff --git a/amd/hipcc/docs/sphinx/requirements.in b/amd/hipcc/docs/sphinx/requirements.in index 0a6d69d8e06251..189f0449162a8f 100644 --- a/amd/hipcc/docs/sphinx/requirements.in +++ b/amd/hipcc/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core>=0.35.0 +rocm-docs-core==1.4.0 diff --git a/amd/hipcc/docs/sphinx/requirements.txt b/amd/hipcc/docs/sphinx/requirements.txt index d7a2ca2dab42be..ee6e29278d724a 100644 --- a/amd/hipcc/docs/sphinx/requirements.txt +++ b/amd/hipcc/docs/sphinx/requirements.txt @@ -1,114 +1,106 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.10 # by the following command: # # pip-compile requirements.in # -accessible-pygments==0.0.3 +accessible-pygments==0.0.5 # via pydata-sphinx-theme -alabaster==0.7.13 +alabaster==0.7.16 # via sphinx -babel==2.12.1 +babel==2.15.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.11.2 +beautifulsoup4==4.12.3 # via pydata-sphinx-theme -breathe==4.34.0 +breathe==4.35.0 # via rocm-docs-core -certifi==2022.12.7 +certifi==2024.6.2 # via requests -cffi==1.15.1 +cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.1.0 +charset-normalizer==3.3.2 # via requests -click==8.1.3 +click==8.1.7 # via sphinx-external-toc -cryptography==40.0.2 +cryptography==42.0.8 # via pyjwt -deprecated==1.2.13 +deprecated==1.2.14 # via pygithub -docutils==0.19 +docutils==0.21.2 # via # breathe # myst-parser # pydata-sphinx-theme # sphinx -fastjsonschema==2.17.1 +fastjsonschema==2.19.1 # via rocm-docs-core -gitdb==4.0.10 +gitdb==4.0.11 # via gitpython -gitpython==3.1.31 +gitpython==3.1.43 # via rocm-docs-core -idna==3.4 +idna==3.7 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==7.0.1 - # via sphinx -importlib-resources==6.1.1 - # via rocm-docs-core -jinja2==3.1.2 +jinja2==3.1.4 # via # myst-parser # sphinx -markdown-it-py==2.2.0 +markdown-it-py==3.0.0 # via # mdit-py-plugins # myst-parser -markupsafe==2.1.2 +markupsafe==2.1.5 # via jinja2 -mdit-py-plugins==0.3.5 +mdit-py-plugins==0.4.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==1.0.0 +myst-parser==3.0.1 # via rocm-docs-core -packaging==23.0 +packaging==24.1 # via # pydata-sphinx-theme # sphinx -pycparser==2.21 +pycparser==2.22 # via cffi -pydata-sphinx-theme==0.13.3 +pydata-sphinx-theme==0.15.3 # via # rocm-docs-core # sphinx-book-theme -pygithub==1.58.1 +pygithub==2.3.0 # via rocm-docs-core -pygments==2.14.0 +pygments==2.18.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.6.0 - # via - # pygithub - # pyjwt +pyjwt[crypto]==2.8.0 + # via pygithub pynacl==1.5.0 # via pygithub -pytz==2023.3.post1 - # via babel -pyyaml==6.0 +pyyaml==6.0.1 # via # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.28.2 +requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core>=0.35.0 +rocm-docs-core==1.4.0 # via -r requirements.in -smmap==5.0.0 +smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.4 +soupsieve==2.5 # via beautifulsoup4 -sphinx==5.3.0 +sphinx==7.3.7 # via # breathe # myst-parser @@ -119,35 +111,37 @@ sphinx==5.3.0 # sphinx-design # sphinx-external-toc # sphinx-notfound-page -sphinx-book-theme==1.0.1 +sphinx-book-theme==1.1.3 # via rocm-docs-core -sphinx-copybutton==0.5.1 +sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.4.1 +sphinx-design==0.6.0 # via rocm-docs-core -sphinx-external-toc==0.3.1 +sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==0.8.3 +sphinx-notfound-page==1.0.2 # via rocm-docs-core -sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-applehelp==1.0.8 # via sphinx -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==1.0.6 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.5 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==1.0.7 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==1.1.10 # via sphinx -typing-extensions==4.5.0 - # via pydata-sphinx-theme -urllib3==1.26.15 - # via requests -wrapt==1.15.0 - # via deprecated -zipp==3.17.0 +tomli==2.0.1 + # via sphinx +typing-extensions==4.12.2 # via - # importlib-metadata - # importlib-resources + # pydata-sphinx-theme + # pygithub +urllib3==2.2.1 + # via + # pygithub + # requests +wrapt==1.16.0 + # via deprecated From ef51dc6c516dff9372a35005c5bece990b15bffd Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Tue, 16 Jul 2024 11:23:25 -0600 Subject: [PATCH 3/4] Conditionally skip docs PR build If there is no change to the docs folder or RTD YAML compared to the amd-staging branch --- amd/hipcc/.readthedocs.yaml | 13 +++++++++++++ openmp/.readthedocs.yaml | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/amd/hipcc/.readthedocs.yaml b/amd/hipcc/.readthedocs.yaml index 173be2324e82d0..523980fe04cd0c 100644 --- a/amd/hipcc/.readthedocs.yaml +++ b/amd/hipcc/.readthedocs.yaml @@ -16,3 +16,16 @@ build: os: ubuntu-22.04 tools: python: "3.10" + jobs: + post_checkout: + # Cancel building pull requests when there aren't changed in the docs directory or YAML file. + # You can add any other files or directories that you'd like here as well, + # like your docs requirements file, or other files that will change your docs build. + # + # If there are no changes (git diff exits with 0) we force the command to return with 183. + # This is a special exit code on Read the Docs that will cancel the build immediately. + - | + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/amd-staging -- docs/ .readthedocs.yaml; + then + exit 183; + fi diff --git a/openmp/.readthedocs.yaml b/openmp/.readthedocs.yaml index 6620c7abff2445..a3dda80bd22097 100644 --- a/openmp/.readthedocs.yaml +++ b/openmp/.readthedocs.yaml @@ -16,3 +16,16 @@ build: os: ubuntu-22.04 tools: python: "3.10" + jobs: + post_checkout: + # Cancel building pull requests when there aren't changed in the docs directory or YAML file. + # You can add any other files or directories that you'd like here as well, + # like your docs requirements file, or other files that will change your docs build. + # + # If there are no changes (git diff exits with 0) we force the command to return with 183. + # This is a special exit code on Read the Docs that will cancel the build immediately. + - | + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/amd-staging -- docs/ .readthedocs.yaml; + then + exit 183; + fi From 1d06282e40ed76ce677aaabed445b84c0600f8ec Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 19 Aug 2024 17:04:55 -0600 Subject: [PATCH 4/4] Update documentation requirements --- amd/hipcc/docs/sphinx/requirements.in | 2 +- amd/hipcc/docs/sphinx/requirements.txt | 42 +++++++++--------- openmp/docs/sphinx/requirements.in | 2 +- openmp/docs/sphinx/requirements.txt | 60 +++++++++++++------------- 4 files changed, 53 insertions(+), 53 deletions(-) diff --git a/amd/hipcc/docs/sphinx/requirements.in b/amd/hipcc/docs/sphinx/requirements.in index 189f0449162a8f..6edebb0e1a952e 100644 --- a/amd/hipcc/docs/sphinx/requirements.in +++ b/amd/hipcc/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==1.4.0 +rocm-docs-core==1.7.1 diff --git a/amd/hipcc/docs/sphinx/requirements.txt b/amd/hipcc/docs/sphinx/requirements.txt index ee6e29278d724a..b104029431dadc 100644 --- a/amd/hipcc/docs/sphinx/requirements.txt +++ b/amd/hipcc/docs/sphinx/requirements.txt @@ -6,9 +6,9 @@ # accessible-pygments==0.0.5 # via pydata-sphinx-theme -alabaster==0.7.16 +alabaster==1.0.0 # via sphinx -babel==2.15.0 +babel==2.16.0 # via # pydata-sphinx-theme # sphinx @@ -16,9 +16,9 @@ beautifulsoup4==4.12.3 # via pydata-sphinx-theme breathe==4.35.0 # via rocm-docs-core -certifi==2024.6.2 +certifi==2024.7.4 # via requests -cffi==1.16.0 +cffi==1.17.0 # via # cryptography # pynacl @@ -26,7 +26,7 @@ charset-normalizer==3.3.2 # via requests click==8.1.7 # via sphinx-external-toc -cryptography==42.0.8 +cryptography==43.0.0 # via pyjwt deprecated==1.2.14 # via pygithub @@ -36,7 +36,7 @@ docutils==0.21.2 # myst-parser # pydata-sphinx-theme # sphinx -fastjsonschema==2.19.1 +fastjsonschema==2.20.0 # via rocm-docs-core gitdb==4.0.11 # via gitpython @@ -60,7 +60,7 @@ mdit-py-plugins==0.4.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==3.0.1 +myst-parser==4.0.0 # via rocm-docs-core packaging==24.1 # via @@ -68,7 +68,7 @@ packaging==24.1 # sphinx pycparser==2.22 # via cffi -pydata-sphinx-theme==0.15.3 +pydata-sphinx-theme==0.15.4 # via # rocm-docs-core # sphinx-book-theme @@ -79,11 +79,11 @@ pygments==2.18.0 # accessible-pygments # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.8.0 +pyjwt[crypto]==2.9.0 # via pygithub pynacl==1.5.0 # via pygithub -pyyaml==6.0.1 +pyyaml==6.0.2 # via # myst-parser # rocm-docs-core @@ -92,15 +92,15 @@ requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core==1.4.0 +rocm-docs-core==1.7.1 # via -r requirements.in smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.5 +soupsieve==2.6 # via beautifulsoup4 -sphinx==7.3.7 +sphinx==8.0.2 # via # breathe # myst-parser @@ -115,23 +115,23 @@ sphinx-book-theme==1.1.3 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.6.0 +sphinx-design==0.6.1 # via rocm-docs-core sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==1.0.2 +sphinx-notfound-page==1.0.4 # via rocm-docs-core -sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-applehelp==2.0.0 # via sphinx -sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-htmlhelp==2.0.5 +sphinxcontrib-htmlhelp==2.1.0 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-qthelp==2.0.0 # via sphinx -sphinxcontrib-serializinghtml==1.1.10 +sphinxcontrib-serializinghtml==2.0.0 # via sphinx tomli==2.0.1 # via sphinx @@ -139,7 +139,7 @@ typing-extensions==4.12.2 # via # pydata-sphinx-theme # pygithub -urllib3==2.2.1 +urllib3==2.2.2 # via # pygithub # requests diff --git a/openmp/docs/sphinx/requirements.in b/openmp/docs/sphinx/requirements.in index c7239510ba62c1..6edebb0e1a952e 100644 --- a/openmp/docs/sphinx/requirements.in +++ b/openmp/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core>=1.0.0 +rocm-docs-core==1.7.1 diff --git a/openmp/docs/sphinx/requirements.txt b/openmp/docs/sphinx/requirements.txt index a13ab177f39419..b104029431dadc 100644 --- a/openmp/docs/sphinx/requirements.txt +++ b/openmp/docs/sphinx/requirements.txt @@ -2,13 +2,13 @@ # This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile --resolver=backtracking requirements.in +# pip-compile requirements.in # -accessible-pygments==0.0.4 +accessible-pygments==0.0.5 # via pydata-sphinx-theme -alabaster==0.7.16 +alabaster==1.0.0 # via sphinx -babel==2.14.0 +babel==2.16.0 # via # pydata-sphinx-theme # sphinx @@ -16,9 +16,9 @@ beautifulsoup4==4.12.3 # via pydata-sphinx-theme breathe==4.35.0 # via rocm-docs-core -certifi==2024.2.2 +certifi==2024.7.4 # via requests -cffi==1.16.0 +cffi==1.17.0 # via # cryptography # pynacl @@ -26,7 +26,7 @@ charset-normalizer==3.3.2 # via requests click==8.1.7 # via sphinx-external-toc -cryptography==42.0.5 +cryptography==43.0.0 # via pyjwt deprecated==1.2.14 # via pygithub @@ -36,7 +36,7 @@ docutils==0.21.2 # myst-parser # pydata-sphinx-theme # sphinx -fastjsonschema==2.19.1 +fastjsonschema==2.20.0 # via rocm-docs-core gitdb==4.0.11 # via gitpython @@ -46,7 +46,7 @@ idna==3.7 # via requests imagesize==1.4.1 # via sphinx -jinja2==3.1.3 +jinja2==3.1.4 # via # myst-parser # sphinx @@ -56,51 +56,51 @@ markdown-it-py==3.0.0 # myst-parser markupsafe==2.1.5 # via jinja2 -mdit-py-plugins==0.4.0 +mdit-py-plugins==0.4.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==3.0.0 +myst-parser==4.0.0 # via rocm-docs-core -packaging==24.0 +packaging==24.1 # via # pydata-sphinx-theme # sphinx pycparser==2.22 # via cffi -pydata-sphinx-theme==0.15.2 +pydata-sphinx-theme==0.15.4 # via # rocm-docs-core # sphinx-book-theme pygithub==2.3.0 # via rocm-docs-core -pygments==2.17.2 +pygments==2.18.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.8.0 +pyjwt[crypto]==2.9.0 # via pygithub pynacl==1.5.0 # via pygithub -pyyaml==6.0.1 +pyyaml==6.0.2 # via # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.31.0 +requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core>=1.0.0 +rocm-docs-core==1.7.1 # via -r requirements.in smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.5 +soupsieve==2.6 # via beautifulsoup4 -sphinx==7.3.7 +sphinx==8.0.2 # via # breathe # myst-parser @@ -111,35 +111,35 @@ sphinx==7.3.7 # sphinx-design # sphinx-external-toc # sphinx-notfound-page -sphinx-book-theme==1.1.2 +sphinx-book-theme==1.1.3 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.5.0 +sphinx-design==0.6.1 # via rocm-docs-core sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==1.0.0 +sphinx-notfound-page==1.0.4 # via rocm-docs-core -sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-applehelp==2.0.0 # via sphinx -sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-htmlhelp==2.0.5 +sphinxcontrib-htmlhelp==2.1.0 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-qthelp==2.0.0 # via sphinx -sphinxcontrib-serializinghtml==1.1.10 +sphinxcontrib-serializinghtml==2.0.0 # via sphinx tomli==2.0.1 # via sphinx -typing-extensions==4.11.0 +typing-extensions==4.12.2 # via # pydata-sphinx-theme # pygithub -urllib3==2.2.1 +urllib3==2.2.2 # via # pygithub # requests