diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4b227351a..b7dab1e99 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,16 +3,20 @@ version: 2 -build: - os: ubuntu-22.04 - tools: - python: "3.10" - sphinx: configuration: docs/conf.py +formats: [htmlzip, pdf, epub] + python: install: - requirements: docs/sphinx/requirements.txt -formats: [htmlzip] +build: + os: ubuntu-22.04 + tools: + python: "3.10" + 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 cdee26699..d9bae715b 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1,2 +1 @@ -rocm-docs-core==1.1.1 -sphinx-reredirects==0.1.3 +rocm-docs-core[api_reference]==1.2.0 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 84c0d167d..a25b13c0e 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -4,22 +4,16 @@ # # pip-compile requirements.in # ---extra-index-url https://test.pypi.org/simple/ - -accessible-pygments==0.0.4 +accessible-pygments==0.0.5 # via pydata-sphinx-theme alabaster==0.7.16 # via sphinx -autodoc==0.5.0 - # via -r requirements.in -babel==2.14.0 +babel==2.15.0 # via # pydata-sphinx-theme # sphinx beautifulsoup4==4.12.3 - # via - # pydata-sphinx-theme - # webtest + # via pydata-sphinx-theme breathe==4.35.0 # via rocm-docs-core certifi==2024.2.2 @@ -37,24 +31,17 @@ click==8.1.7 # sphinx-external-toc click-log==0.4.0 # via doxysphinx -cryptography==42.0.5 +cryptography==42.0.7 # via pyjwt -decorator==5.1.1 - # via autodoc -defusedxml==0.7.1 - # via sphinxcontrib-datatemplates deprecated==1.2.14 # via pygithub docutils==0.21.2 # via # breathe # myst-parser - # pybtex-docutils # pydata-sphinx-theme # sphinx - # sphinx-substitution-extensions - # sphinxcontrib-bibtex -doxysphinx==3.3.7 +doxysphinx==3.3.8 # via rocm-docs-core fastjsonschema==2.19.1 # via rocm-docs-core @@ -62,12 +49,6 @@ gitdb==4.0.11 # via gitpython gitpython==3.1.43 # via rocm-docs-core -hip-python==6.1.0.470.16 - # via - # -r requirements.in - # hip-python-as-cuda -hip-python-as-cuda==6.1.0.470.16 - # via -r requirements.in idna==3.7 # via requests imagesize==1.4.1 @@ -76,8 +57,6 @@ jinja2==3.1.4 # via # myst-parser # sphinx -latexcodec==3.0.0 - # via pybtex libsass==0.22.0 # via doxysphinx lxml==4.9.4 @@ -88,35 +67,29 @@ 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 -mpire==2.10.1 +mpire==2.10.2 # via doxysphinx -myst-parser==3.0.0 +myst-parser==3.0.1 # via rocm-docs-core numpy==1.26.4 - # via -r requirements.in + # via doxysphinx packaging==24.0 # via # pydata-sphinx-theme # sphinx -pybtex==0.24.0 - # via - # pybtex-docutils - # sphinxcontrib-bibtex -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 @@ -133,18 +106,14 @@ pyparsing==3.1.2 pyyaml==6.0.1 # via # myst-parser - # pybtex # rocm-docs-core # sphinx-external-toc - # sphinxcontrib-datatemplates -requests==2.31.0 +requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core==1.1.1 +rocm-docs-core[api-reference]==1.2.0 # via -r requirements.in -six==1.16.0 - # via pybtex smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 @@ -158,56 +127,43 @@ sphinx==7.3.7 # pydata-sphinx-theme # rocm-docs-core # sphinx-book-theme - # sphinx-collapse # sphinx-copybutton # sphinx-design # sphinx-external-toc # sphinx-notfound-page - # sphinx-reredirects - # sphinx-substitution-extensions - # sphinxcontrib-bibtex - # sphinxcontrib-datatemplates - # sphinxcontrib-moderncmakedomain - # sphinxcontrib-runcmd sphinx-book-theme==1.1.2 # via rocm-docs-core -sphinx-collapse==0.1.3 - # via -r requirements.in 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 -sphinx-reredirects==0.1.3 - # via -r requirements.in -sphinx-substitution-extensions==2022.2.16 - # via -r requirements.in sphinxcontrib-applehelp==1.0.8 # via sphinx -sphinxcontrib-bibtex==2.6.2 - # via -r requirements.in -sphinxcontrib-datatemplates==0.11.0 - # via -r requirements.in sphinxcontrib-devhelp==1.0.6 # via sphinx 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-runcmd==0.2.0 - # via sphinxcontrib-datatemplates sphinxcontrib-serializinghtml==1.1.10 # via sphinx -typing-extensions==4.5.0 - # via pydata-sphinx-theme -urllib3==1.26.18 - # via requests -wrapt==1.14.1 +tomli==2.0.1 + # via sphinx +tqdm==4.66.4 + # via mpire +typing-extensions==4.12.0 + # via + # pydata-sphinx-theme + # pygithub +urllib3==2.2.1 + # via + # pygithub + # requests +wrapt==1.16.0 # via deprecated