From 0cc7d28c8d3bcb9c70222c05d21b8a41ff89b825 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Thu, 6 Jun 2024 16:44:54 -0600 Subject: [PATCH] Update documentation requirements --- .readthedocs.yaml | 22 ++++++++------ docs/sphinx/requirements.in | 2 +- docs/sphinx/requirements.txt | 57 ++++++++++-------------------------- 3 files changed, 30 insertions(+), 51 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d5c98c3ee0..b7dab1e997 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,16 +3,20 @@ version: 2 +sphinx: + configuration: docs/conf.py + +formats: [htmlzip, pdf, epub] + +python: + install: + - requirements: docs/sphinx/requirements.txt + build: os: ubuntu-22.04 tools: python: "3.10" - -sphinx: - configuration: docs/conf.py - -python: - install: - - requirements: docs/.sphinx/requirements.txt - -formats: [htmlzip, pdf, epub] + apt_packages: + - "doxygen" + - "gfortran" # For pre-processing fortran sources + - "graphviz" # For dot graphs in doxygen diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index a854542439..9c9706c664 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1,2 +1,2 @@ -rocm-docs-core==0.38.1 +rocm-docs-core==1.4.0 sphinxcontrib-bibtex==2.6.2 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 15756f6783..1e71a782f8 100644 --- a/docs/sphinx/requirements.txt +++ b/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 # via sphinx -babel==2.14.0 +babel==2.15.0 # via # pydata-sphinx-theme # sphinx @@ -16,7 +16,7 @@ beautifulsoup4==4.12.3 # via pydata-sphinx-theme breathe==4.35.0 # via rocm-docs-core -certifi==2024.2.2 +certifi==2024.6.2 # via requests cffi==1.16.0 # via @@ -25,13 +25,8 @@ cffi==1.16.0 charset-normalizer==3.3.2 # via requests click==8.1.7 - # via - # click-log - # doxysphinx - # sphinx-external-toc -click-log==0.4.0 - # via doxysphinx -cryptography==42.0.5 + # via sphinx-external-toc +cryptography==42.0.8 # via pyjwt deprecated==1.2.14 # via pygithub @@ -43,8 +38,6 @@ docutils==0.21.2 # pydata-sphinx-theme # sphinx # sphinxcontrib-bibtex -doxysphinx==3.3.7 - # via rocm-docs-core fastjsonschema==2.19.1 # via rocm-docs-core gitdb==4.0.11 @@ -55,32 +48,24 @@ idna==3.7 # via requests imagesize==1.4.1 # via sphinx -jinja2==3.1.3 +jinja2==3.1.4 # via # myst-parser # sphinx latexcodec==3.0.0 # via pybtex -libsass==0.22.0 - # via doxysphinx -lxml==4.9.4 - # via doxysphinx markdown-it-py==3.0.0 # via # mdit-py-plugins # 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 -mpire==2.10.1 - # via doxysphinx -myst-parser==3.0.0 +myst-parser==3.0.1 # via rocm-docs-core -numpy==1.26.4 - # via -r requirements.in packaging==24.0 # via # pydata-sphinx-theme @@ -93,37 +78,32 @@ pybtex-docutils==1.0.3 # via sphinxcontrib-bibtex pycparser==2.22 # via cffi -pydata-sphinx-theme==0.15.2 +pydata-sphinx-theme==0.15.3 # 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 - # mpire # pydata-sphinx-theme # sphinx -pyjson5==1.6.6 - # via doxysphinx pyjwt[crypto]==2.8.0 # via pygithub pynacl==1.5.0 # via pygithub -pyparsing==3.1.2 - # via doxysphinx pyyaml==6.0.1 # via # myst-parser # pybtex # rocm-docs-core # sphinx-external-toc -requests==2.31.0 +requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core[api_reference]==1.1.0 +rocm-docs-core==1.4.0 # via -r requirements.in six==1.16.0 # via pybtex @@ -145,16 +125,15 @@ sphinx==7.3.7 # sphinx-external-toc # sphinx-notfound-page # sphinxcontrib-bibtex - # sphinxcontrib-moderncmakedomain sphinx-book-theme==1.1.2 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.5.0 +sphinx-design==0.6.0 # 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.2 # via rocm-docs-core sphinxcontrib-applehelp==1.0.8 # via sphinx @@ -166,17 +145,13 @@ sphinxcontrib-htmlhelp==2.0.5 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-moderncmakedomain==3.27.0 - # via -r requirements.in sphinxcontrib-qthelp==1.0.7 # via sphinx sphinxcontrib-serializinghtml==1.1.10 # via sphinx tomli==2.0.1 # via sphinx -tqdm==4.66.2 - # via mpire -typing-extensions==4.11.0 +typing-extensions==4.12.1 # via # pydata-sphinx-theme # pygithub