Skip to content

Commit

Permalink
Bump rocm-docs-core[api_reference] from 0.23.0 to 0.24.0 in /docs/sph…
Browse files Browse the repository at this point in the history
…inx (#121)

* Bump rocm-docs-core[api_reference] from 0.23.0 to 0.24.0 in /docs/sphinx

Bumps [rocm-docs-core[api_reference]](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.23.0 to 0.24.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](ROCm/rocm-docs-core@v0.23.0...v0.24.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Update requirements.in

* Update requirements.txt

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sam Wu <[email protected]>
  • Loading branch information
dependabot[bot] and samjwu committed Sep 7, 2023
1 parent 1750dcb commit 41f33ee
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ formats: [htmlzip]

python:
install:
- requirements: docs/.sphinx/requirements.txt
- requirements: docs/sphinx/requirements.txt

build:
os: ubuntu-20.04
Expand Down
1 change: 0 additions & 1 deletion docs/.sphinx/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion docs/.sphinx/.python-version

This file was deleted.

1 change: 0 additions & 1 deletion docs/.sphinx/requirements.in

This file was deleted.

23 changes: 21 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@

import glob
import os
import re
import shutil
import subprocess
from pathlib import Path
from typing import Dict, List, Any
from typing import Any, Dict, List

from rocm_docs import ROCmDocs

Expand Down Expand Up @@ -44,11 +45,29 @@
]
)

docs_core = ROCmDocs("hipfort Documentation")
with open('../CMakeLists.txt', encoding='utf-8') as f:
match = re.search(r'.*\bHIPFORT_VERSION\s+\"?([0-9.]+)[^0-9.]+', f.read())
if not match:
raise ValueError("HIPFORT_VERSION not found!")
version_number = match[1]
left_nav_title = f"hipfort {version_number} Documentation"

# for PDF output on Read the Docs
project = "hipfort Documentation"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
version = version_number
release = version_number

external_toc_path = "./sphinx/_toc.yml"

docs_core = ROCmDocs(left_nav_title)
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
docs_core.enable_api_reference()
docs_core.setup()

external_projects_current_project = "hipfort"

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_toc.yml
File renamed without changes.
1 change: 1 addition & 0 deletions docs/sphinx/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rocm-docs-core[api_reference]>=0.24.0
72 changes: 34 additions & 38 deletions docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is autogenerated by pip-compile with Python 3.8
# by the following command:
#
# pip-compile .sphinx/requirements.in
# pip-compile --resolver=backtracking requirements.in
#
accessible-pygments==0.0.4
# via pydata-sphinx-theme
Expand All @@ -14,72 +14,70 @@ babel==2.12.1
# sphinx
beautifulsoup4==4.12.2
# via pydata-sphinx-theme
breathe==4.34.0
breathe==4.35.0
# via rocm-docs-core
certifi==2022.12.7
certifi==2023.7.22
# via requests
cffi==1.15.1
# via
# cryptography
# pynacl
charset-normalizer==3.1.0
charset-normalizer==3.2.0
# via requests
click==8.1.3
click==8.1.7
# via
# click-log
# doxysphinx
# sphinx-external-toc
click-log==0.4.0
# via doxysphinx
cryptography==40.0.2
cryptography==41.0.3
# via pyjwt
deprecated==1.2.13
deprecated==1.2.14
# via pygithub
docutils==0.16
docutils==0.19
# via
# breathe
# myst-parser
# pydata-sphinx-theme
# sphinx
doxysphinx==3.3.3
doxysphinx==3.3.4
# via rocm-docs-core
fastjsonschema==2.16.3
fastjsonschema==2.18.0
# via rocm-docs-core
gitdb==4.0.10
# via gitpython
gitpython==3.1.31
gitpython==3.1.35
# via rocm-docs-core
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
importlib-metadata==6.4.1
importlib-metadata==6.8.0
# via sphinx
importlib-resources==5.10.4
importlib-resources==6.0.1
# via rocm-docs-core
jinja2==3.1.2
# via
# myst-parser
# sphinx
libsass==0.22.0
# via doxysphinx
linkify-it-py==1.0.3
# via myst-parser
lxml==4.9.2
lxml==4.9.3
# via doxysphinx
markdown-it-py==2.2.0
# via
# mdit-py-plugins
# myst-parser
markupsafe==2.1.2
markupsafe==2.1.3
# via jinja2
mdit-py-plugins==0.3.5
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
mpire==2.7.1
mpire==2.8.0
# via doxysphinx
myst-parser[linkify]==1.0.0
myst-parser==1.0.0
# via rocm-docs-core
packaging==23.1
# via
Expand All @@ -91,40 +89,40 @@ pydata-sphinx-theme==0.13.3
# via
# rocm-docs-core
# sphinx-book-theme
pygithub==1.58.2
pygithub==1.59.1
# via rocm-docs-core
pygments==2.15.0
pygments==2.16.1
# via
# accessible-pygments
# mpire
# pydata-sphinx-theme
# sphinx
pyjson5==1.6.2
pyjson5==1.6.4
# via doxysphinx
pyjwt[crypto]==2.6.0
pyjwt[crypto]==2.8.0
# via pygithub
pynacl==1.5.0
# via pygithub
pyparsing==3.0.9
pyparsing==3.1.1
# via doxysphinx
pytz==2023.3
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.31.0
# via
# pygithub
# sphinx
rocm-docs-core[api_reference]==0.13.4
rocm-docs-core[api_reference]==0.24.0
# via -r requirements.in
smmap==5.0.0
# via gitdb
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
soupsieve==2.5
# via beautifulsoup4
sphinx==5.3.0
# via
Expand All @@ -139,13 +137,13 @@ sphinx==5.3.0
# sphinx-notfound-page
sphinx-book-theme==1.0.1
# via rocm-docs-core
sphinx-copybutton==0.5.1
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.3.0
sphinx-design==0.5.0
# via rocm-docs-core
sphinx-external-toc==0.3.1
# via rocm-docs-core
sphinx-notfound-page==0.8.3
sphinx-notfound-page==1.0.0
# via rocm-docs-core
sphinxcontrib-applehelp==1.0.4
# via sphinx
Expand All @@ -159,17 +157,15 @@ sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
tqdm==4.65.0
tqdm==4.66.1
# via mpire
typing-extensions==4.5.0
typing-extensions==4.7.1
# via pydata-sphinx-theme
uc-micro-py==1.0.1
# via linkify-it-py
urllib3==1.26.15
urllib3==2.0.4
# via requests
wrapt==1.15.0
# via deprecated
zipp==3.15.0
zipp==3.16.2
# via
# importlib-metadata
# importlib-resources

0 comments on commit 41f33ee

Please sign in to comment.