diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3be33d1f2..d5c98c3ee 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,12 +3,16 @@ version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.10" + sphinx: configuration: docs/conf.py -formats: [htmlzip, pdf, epub] - python: - version: "3.8" install: - - requirements: docs/sphinx/requirements.txt + - requirements: docs/.sphinx/requirements.txt + +formats: [htmlzip, pdf, epub] diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in new file mode 100644 index 000000000..c475029e1 --- /dev/null +++ b/docs/.sphinx/requirements.in @@ -0,0 +1,11 @@ +rocm-docs-core[api_reference]==1.1.1 +--extra-index-url https://test.pypi.org/simple/ +Sphinx-Substitution-Extensions +autodoc +hip-python +hip-python-as-cuda +numpy +sphinx-collapse +sphinxcontrib-bibtex +sphinxcontrib-moderncmakedomain +sphinxcontrib.datatemplates diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt new file mode 100644 index 000000000..201d1c377 --- /dev/null +++ b/docs/.sphinx/requirements.txt @@ -0,0 +1,224 @@ +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile requirements.in +# +--extra-index-url https://test.pypi.org/simple/ + +accessible-pygments==0.0.4 + # via pydata-sphinx-theme +alabaster==0.7.16 + # via sphinx +autodoc==0.5.0 + # via -r requirements.in +babel==2.14.0 + # via + # pydata-sphinx-theme + # sphinx +beautifulsoup4==4.12.3 + # via + # pydata-sphinx-theme + # webtest +breathe==4.35.0 + # via rocm-docs-core +certifi==2024.2.2 + # via requests +cffi==1.16.0 + # via + # cryptography + # pynacl +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 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 + # via rocm-docs-core +fastjsonschema==2.19.1 + # via rocm-docs-core +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 + # via sphinx +jinja2==3.1.3 + # 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 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +mpire==2.10.1 + # via doxysphinx +myst-parser==3.0.0 + # via rocm-docs-core +numpy==1.26.4 + # via -r requirements.in +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 + # via + # rocm-docs-core + # sphinx-book-theme +pygithub==2.3.0 + # via rocm-docs-core +pygments==2.17.2 + # 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 + # sphinxcontrib-datatemplates +requests==2.31.0 + # via + # pygithub + # sphinx +rocm-docs-core[api-reference]==1.1.1 + # via -r requirements.in +six==1.16.0 + # via pybtex +smmap==5.0.1 + # via gitdb +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.5 + # via beautifulsoup4 +sphinx==7.3.7 + # via + # breathe + # myst-parser + # pydata-sphinx-theme + # rocm-docs-core + # sphinx-book-theme + # sphinx-collapse + # sphinx-copybutton + # sphinx-design + # sphinx-external-toc + # sphinx-notfound-page + # 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 + # via rocm-docs-core +sphinx-external-toc==1.0.1 + # via rocm-docs-core +sphinx-notfound-page==1.0.0 + # via rocm-docs-core +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 +tomli==2.0.1 + # via sphinx +tqdm==4.66.2 + # via mpire +typing-extensions==4.11.0 + # via + # pydata-sphinx-theme + # pygithub +urllib3==2.2.1 + # via + # pygithub + # requests +waitress==3.0.0 + # via webtest +webob==1.8.7 + # via webtest +webtest==3.0.0 + # via autodoc +wrapt==1.16.0 + # via deprecated