diff --git a/CHANGELOG.md b/CHANGELOG.md index 67f6c53d..688a86b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,28 @@ +## v1.18.1 (2025-03-12) + +### Fix + +- rename header + +## v1.18.0 (2025-03-12) + +### Feat + +- add ai-developer-hub flavor + +### Fix + +- fix linting +- fix typo +- remove -docs suffix for consistency + +## v1.17.1 (2025-03-03) + +### Fix + +- prevent rocm-ds using rocm latest version +- add version_list() definition + ## v1.17.0 (2025-02-19) ### Feat diff --git a/docs/conf.py b/docs/conf.py index 5fc27706..21aca533 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,8 +51,8 @@ "path": "demo/doxygen/xml", } -version = "1.17.0" -release = "1.17.0" +version = "1.18.1" +release = "1.18.1" html_title = f"ROCm Docs Core {version}" project = "ROCm Docs Core" author = "Advanced Micro Devices, Inc." diff --git a/pyproject.toml b/pyproject.toml index 010118ba..c5cb14c2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" [project] name = 'rocm-docs-core' -version = "1.17.0" +version = "1.18.1" authors=[ {name="Lauren Wrubleski", email="Lauren.Wrubleski@amd.com"} ] @@ -72,7 +72,7 @@ color = true [tool.commitizen] name = "cz_conventional_commits" -version = "1.17.0" +version = "1.18.1" version_files = ["pyproject.toml:^version", "docs/conf.py:^(version|release)"] tag_format = "v$version" annotated_tag = true diff --git a/requirements.txt b/requirements.txt index 3bd47078..a4f3df24 100644 --- a/requirements.txt +++ b/requirements.txt @@ -25,7 +25,7 @@ beautifulsoup4==4.13.3 # via pydata-sphinx-theme black==25.1.0 # via rocm-docs-core (pyproject.toml) -breathe==4.35.0 +breathe==4.36.0 # via rocm-docs-core (pyproject.toml) build==1.2.2.post1 # via @@ -57,19 +57,19 @@ colorama==0.4.6 # via commitizen comm==0.2.2 # via ipykernel -commitizen==4.2.2 +commitizen==4.4.1 # via rocm-docs-core (pyproject.toml) contourpy==1.3.1 # via matplotlib -cryptography==44.0.1 +cryptography==44.0.2 # via pyjwt cycler==0.12.1 # via matplotlib -debugpy==1.8.12 +debugpy==1.8.13 # via ipykernel decli==0.6.2 # via commitizen -decorator==5.1.1 +decorator==5.2.1 # via ipython deprecated==1.2.18 # via pygithub @@ -103,7 +103,7 @@ gitpython==3.1.44 # via rocm-docs-core (pyproject.toml) greenlet==3.1.1 # via sqlalchemy -identify==2.6.7 +identify==2.6.9 # via pre-commit idna==3.10 # via requests @@ -117,15 +117,15 @@ iniconfig==2.0.0 # via pytest ipykernel==6.29.5 # via myst-nb -ipython==8.32.0 +ipython==8.33.0 # via # ipykernel # myst-nb -isort==6.0.0 +isort==6.0.1 # via rocm-docs-core (pyproject.toml) jedi==0.19.2 # via ipython -jinja2==3.1.5 +jinja2==3.1.6 # via # commitizen # myst-parser @@ -158,7 +158,7 @@ markdown-it-py==3.0.0 # myst-parser markupsafe==3.0.2 # via jinja2 -matplotlib==3.10.0 +matplotlib==3.10.1 # via doxysphinx matplotlib-inline==0.1.7 # via @@ -242,7 +242,7 @@ pydata-sphinx-theme==0.16.1 # via # rocm-docs-core (pyproject.toml) # sphinx-book-theme -pygithub==2.6.0 +pygithub==2.6.1 # via rocm-docs-core (pyproject.toml) pygments==2.19.1 # via @@ -266,7 +266,7 @@ pyproject-hooks==1.2.0 # via # build # pip-tools -pytest==8.3.4 +pytest==8.3.5 # via rocm-docs-core (pyproject.toml) python-dateutil==2.9.0.post0 # via @@ -296,11 +296,11 @@ requests==2.32.3 # via # pygithub # sphinx -rpds-py==0.22.3 +rpds-py==0.23.1 # via # jsonschema # referencing -ruff==0.9.6 +ruff==0.9.10 # via rocm-docs-core (pyproject.toml) six==1.17.0 # via python-dateutil @@ -337,7 +337,7 @@ sphinxcontrib-applehelp==2.0.0 # via sphinx sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-doxylink==1.12.4 +sphinxcontrib-doxylink==1.13.0 # via rocm-docs-core (pyproject.toml) sphinxcontrib-htmlhelp==2.1.0 # via sphinx @@ -396,7 +396,7 @@ urllib3==2.3.0 # via # pygithub # requests -virtualenv==20.29.2 +virtualenv==20.29.3 # via pre-commit wcwidth==0.2.13 # via prompt-toolkit diff --git a/src/rocm_docs/data/projects.yaml b/src/rocm_docs/data/projects.yaml index 26367bb1..3491ae9c 100644 --- a/src/rocm_docs/data/projects.yaml +++ b/src/rocm_docs/data/projects.yaml @@ -8,7 +8,7 @@ projects: target: https://rocm.docs.amd.com/projects/amdsmi/en/${version} development_branch: amd-staging composable_kernel: https://rocm.docs.amd.com/projects/composable_kernel/en/${version} - gpuaidev-docs: + gpuaidev: target: https://rocm.docs.amd.com/projects/ai-developer-hub/en/${version} development_branch: main hip: diff --git a/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/footer.jinja b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/footer.jinja new file mode 100644 index 00000000..c7b8ed0a --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/footer.jinja @@ -0,0 +1 @@ +{% macro license_link() -%}{%- endmacro -%} diff --git a/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/header.jinja new file mode 100644 index 00000000..242b118e --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/header.jinja @@ -0,0 +1,35 @@ +{% macro top_level_header(branch, latest_version, release_candidate_version) -%} + {% if branch in ["develop", "master", "main", "amd-master", "amd-staging"] %} + {% set version_name = "Future Release" %} + {% elif branch == "latest" %} + {% set version_name = "" %} + {% else %} + {% set version_name = branch %} + {% endif %} + AI Tutorials {{ version_name }} +{%- endmacro -%} + +{% if theme_repository_url.endswith("-docs") %} + {% set repo_url = theme_repository_url|replace("-docs", "") %} +{% else %} + {% set repo_url = theme_repository_url %} +{% endif %} + +{% set repo_url = repo_url|replace("http://", "https://") %} + +{% macro version_list() -%} + Version List +{%- endmacro -%} + +{% +set nav_secondary_items = { + "GitHub": repo_url, + "Community": "https://github.com/ROCm/ROCm/discussions", + "Blogs": "https://rocm.blogs.amd.com/", + "ROCm™ Docs": "https://rocm.docs.amd.com", + "ROCm Developer Hub": "https://www.amd.com/en/developer/resources/rocm-hub.html", + "Instinct™ Docs": "https://instinct.docs.amd.com", + "Infinity Hub": "https://www.amd.com/en/developer/resources/infinity-hub.html", + "Support": repo_url + "/issues/new/choose" +} +%} diff --git a/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/left-side-menu.jinja b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/left-side-menu.jinja new file mode 100644 index 00000000..ab637c81 --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/flavors/ai-developer-hub/left-side-menu.jinja @@ -0,0 +1,3 @@ +{% +set main_doc_link = ("AI Developer", projects['gpuaidev']) +%} diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm-ds/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm-ds/header.jinja index ce909694..762a45b2 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm-ds/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm-ds/header.jinja @@ -1,8 +1,6 @@ {% macro top_level_header(branch, latest_version, release_candidate_version) -%} {% if branch in ["develop", "master", "main", "amd-master", "amd-staging"] %} {% set version_name = "Future Release" %} - {% elif branch == "latest" %} - {% set version_name = latest_version %} {% else %} {% set version_name = branch %} {% endif %} @@ -17,6 +15,12 @@ {% set repo_url = repo_url|replace("http://", "https://") %} +{% macro version_list() -%} + {% if theme_version_list_link %} + Version List + {% endif %} +{%- endmacro -%} + {% set nav_secondary_items = { "GitHub": repo_url, diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index 85037aae..13710c7a 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -120,6 +120,7 @@ def _update_theme_options(app: Sphinx) -> None: "rocm-blogs", "generic", "rocm-ds", + "ai-developer-hub", ] flavor = theme_opts.get("flavor", "rocm") if flavor not in supported_flavors: