Skip to content

Commit

Permalink
Update documentation requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
samjwu committed May 31, 2024
1 parent f21b775 commit 8388d02
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 40 deletions.
13 changes: 1 addition & 12 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,5 @@ build:
python: "3.10"
apt_packages:
- "doxygen"
- "gfortran" # For pre-processing fortran sources
- "graphviz" # For dot graphs in doxygen
jobs:

This comment has been minimized.

Copy link
@neon60

neon60 Jun 6, 2024

Contributor

@samjwu I am just curious. Why are you removing this section at docs release branch?

This comment has been minimized.

Copy link
@samjwu

samjwu Jun 6, 2024

Author Member

Thanks for catching that. I have added it back in. I have a script that automatically updates the RTD config and doc requirements files, but it uses a default

post_checkout:
- if [ -d ../llvm-project ]; then rmdir ../llvm-project; fi
- if [ -d ../clr ]; then rmdir ../clr; fi
- if [ -d ../ROCR-Runtime ]; then rmdir ../ROCR-Runtime; fi
- git clone --depth=1 --single-branch --branch rocdoc-195 https://github.com/StreamHPC/llvm-project.git ../llvm-project
- git clone --depth=1 --single-branch --branch develop https://github.com/ROCm/clr.git ../clr
- git clone --depth=1 --single-branch --branch master https://github.com/ROCm/ROCR-Runtime.git ../ROCR-Runtime
post_build:
- rm -rf ../clr
- rm -rf ../llvm-project
- rm -rf ../ROCR-Runtime
3 changes: 1 addition & 2 deletions docs/sphinx/requirements.in
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
rocm-docs-core[api_reference]==1.1.1
sphinxcontrib.doxylink
rocm-docs-core[api_reference]==1.2.0
45 changes: 19 additions & 26 deletions docs/sphinx/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
#
# 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
Expand All @@ -31,7 +31,7 @@ click==8.1.7
# sphinx-external-toc
click-log==0.4.0
# via doxysphinx
cryptography==42.0.5
cryptography==42.0.7
# via pyjwt
deprecated==1.2.14
# via pygithub
Expand All @@ -41,7 +41,7 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
doxysphinx==3.3.7
doxysphinx==3.3.8
# via rocm-docs-core
fastjsonschema==2.19.1
# via rocm-docs-core
Expand All @@ -53,7 +53,7 @@ idna==3.7
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.3
jinja2==3.1.4
# via
# myst-parser
# sphinx
Expand All @@ -67,27 +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 doxysphinx
packaging==24.0
# via
# pydata-sphinx-theme
# sphinx
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
Expand All @@ -100,24 +102,18 @@ pyjwt[crypto]==2.8.0
pynacl==1.5.0
# via pygithub
pyparsing==3.1.2
# via
# doxysphinx
# sphinxcontrib-doxylink
python-dateutil==2.9.0.post0
# via sphinxcontrib-doxylink
# via doxysphinx
pyyaml==6.0.1
# via
# myst-parser
# rocm-docs-core
# sphinx-external-toc
requests==2.31.0
requests==2.32.3
# via
# pygithub
# sphinx
rocm-docs-core[api-reference]==1.1.1
rocm-docs-core[api-reference]==1.2.0
# via -r requirements.in
six==1.16.0
# via python-dateutil
smmap==5.0.1
# via gitdb
snowballstemmer==2.2.0
Expand All @@ -135,23 +131,20 @@ sphinx==7.3.7
# sphinx-design
# sphinx-external-toc
# sphinx-notfound-page
# sphinxcontrib-doxylink
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
sphinxcontrib-devhelp==1.0.6
# via sphinx
sphinxcontrib-doxylink==1.12.3
# via -r requirements.in
sphinxcontrib-htmlhelp==2.0.5
# via sphinx
sphinxcontrib-jsmath==1.0.1
Expand All @@ -162,9 +155,9 @@ sphinxcontrib-serializinghtml==1.1.10
# via sphinx
tomli==2.0.1
# via sphinx
tqdm==4.66.2
tqdm==4.66.4
# via mpire
typing-extensions==4.11.0
typing-extensions==4.12.0
# via
# pydata-sphinx-theme
# pygithub
Expand Down

0 comments on commit 8388d02

Please sign in to comment.