From 36be2fc7e41696675c80cea3bffbde9b21e25a30 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:32:10 -0600 Subject: [PATCH 01/14] feat: Add template for google site verification content --- src/rocm_docs/rocm_docs_theme/flavors/rocm/meta.jinja | 3 +++ src/rocm_docs/rocm_docs_theme/sections/meta.html | 7 +++++++ 2 files changed, 10 insertions(+) create mode 100644 src/rocm_docs/rocm_docs_theme/flavors/rocm/meta.jinja create mode 100644 src/rocm_docs/rocm_docs_theme/sections/meta.html diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm/meta.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm/meta.jinja new file mode 100644 index 00000000..004db6a3 --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm/meta.jinja @@ -0,0 +1,3 @@ +{% macro google_site_verification(google_site_verification_content) -%} + +{%- endmacro -%} diff --git a/src/rocm_docs/rocm_docs_theme/sections/meta.html b/src/rocm_docs/rocm_docs_theme/sections/meta.html new file mode 100644 index 00000000..4a6b3833 --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/sections/meta.html @@ -0,0 +1,7 @@ +{% +from "flavors/" ~ theme_flavor ~ "/meta.jinja" import + google_site_verification +with context +%} + +{{ google_site_verification(google_site_verification_content) }} From 253832670b2e1f7cced45185db305f24e82a6e33 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:36:41 -0600 Subject: [PATCH 02/14] feat: Add google site verification content to theme context --- src/rocm_docs/theme.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index f8ad196c..65279cb3 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -36,16 +36,22 @@ def _add_custom_context( header_latest_version = _get_version_from_url( "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/latest_version.txt" ) + context["header_latest_version"] = header_latest_version header_release_candidate_version = _get_version_from_url( "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/release_candidate.txt" ) - - context["header_latest_version"] = header_latest_version context["header_release_candidate_version"] = ( header_release_candidate_version ) + google_site_verification_content = _get_version_from_url( + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/google_site_verification.txt" + ) + context["google_site_verification_content"] = ( + google_site_verification_content + ) + def _update_repo_opts(srcdir: str, theme_opts: dict[str, Any]) -> None: default_branch_options: dict[str, Any] = { From 5e2bbc33f6e5ff33a51fc357ee3ae6aa303c1769 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:38:31 -0600 Subject: [PATCH 03/14] refactor: Get versions from data branch instead of header-versions branch --- src/rocm_docs/projects.py | 4 ++-- src/rocm_docs/theme.py | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/rocm_docs/projects.py b/src/rocm_docs/projects.py index 6c073135..cea529f6 100644 --- a/src/rocm_docs/projects.py +++ b/src/rocm_docs/projects.py @@ -324,11 +324,11 @@ def _update_theme_configs( ) -> None: """Update configurations for use in theme.py""" latest_version = requests.get( - "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/latest_version.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/latest_version.txt" ).text.strip("\r\n") latest_version_string = f"docs-{latest_version}" release_candidate = requests.get( - "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/release_candidate.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/release_candidate.txt" ).text.strip("\r\n") release_candidate_string = f"docs-{release_candidate}" diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index 65279cb3..fb9a9fd9 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -34,12 +34,12 @@ def _add_custom_context( doctree: object, # noqa: ARG001 ) -> None: header_latest_version = _get_version_from_url( - "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/latest_version.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/latest_version.txt" ) context["header_latest_version"] = header_latest_version header_release_candidate_version = _get_version_from_url( - "https://raw.githubusercontent.com/ROCm/rocm-docs-core/header-versions/release_candidate.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/release_candidate.txt" ) context["header_release_candidate_version"] = ( header_release_candidate_version @@ -125,11 +125,11 @@ def _update_theme_options(app: Sphinx) -> None: ) header_latest_version = _get_version_from_url( - "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/header-versions/latest_version.txt" + "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/data/latest_version.txt" ) header_release_candidate_version = _get_version_from_url( - "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/header-versions/release_candidate.txt" + "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/data/release_candidate.txt" ) default_config_opts = { From 039858d6bc8f0e552816a3ab2e30f2ce48cee01a Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:43:48 -0600 Subject: [PATCH 04/14] docs: Update links to use ROCm from RadeonOpenCompute --- .github/workflows/linting.yml | 6 +++--- README.md | 2 +- docs/developer_guide/dependabot.md | 4 ++-- docs/developer_guide/just.md | 4 ++-- docs/user_guide/doxygen_integration.md | 2 +- docs/user_guide/linking.md | 6 +++--- pyproject.toml | 2 +- requirements.txt | 5 +++-- src/rocm_docs/data/projects.schema.json | 2 +- src/rocm_docs/projects.py | 2 +- .../rocm_docs_theme/flavors/rocm-blogs/header.jinja | 2 +- src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja | 2 +- src/rocm_docs/theme.py | 4 ++-- 13 files changed, 22 insertions(+), 21 deletions(-) diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index c96c7d8d..8361b43a 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -21,7 +21,7 @@ jobs: - name: Fetch config shell: sh run: | - test -f .markdownlint.yaml && echo "Using local config file" || curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.markdownlint.yaml -O + test -f .markdownlint.yaml && echo "Using local config file" || curl --silent --show-error --fail --location https://raw.github.com/ROCm/rocm-docs-core/develop/.markdownlint.yaml -O - name: Use markdownlint-cli2 uses: DavidAnson/markdownlint-cli2-action@v10.0.1 with: @@ -37,8 +37,8 @@ jobs: if: ${{ ! contains( github.repository, 'rocm-docs-core') }} shell: sh run: | - curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.spellcheck.yaml -O - curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.wordlist.txt >> .wordlist.txt + curl --silent --show-error --fail --location https://raw.github.com/ROCm/rocm-docs-core/develop/.spellcheck.yaml -O + curl --silent --show-error --fail --location https://raw.github.com/ROCm/rocm-docs-core/develop/.wordlist.txt >> .wordlist.txt - name: Run spellcheck uses: rojopolis/spellcheck-github-actions@0.30.0 - name: On fail diff --git a/README.md b/README.md index c1dd6116..7c61728d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This repository is comprised of utilities, styling, scripts, and additional HTML - Install this repository as a Python package using pip - From PyPi: `pip install rocm-docs-core` - - From GitHub: `pip install git+https://github.com/RadeonOpenCompute/rocm-docs-core.git`. + - From GitHub: `pip install git+https://github.com/ROCm/rocm-docs-core.git`. - Set `rocm_docs_theme` as the HTML theme - Add `rocm_docs` as an extension diff --git a/docs/developer_guide/dependabot.md b/docs/developer_guide/dependabot.md index 7bbd6f3d..f348d848 100644 --- a/docs/developer_guide/dependabot.md +++ b/docs/developer_guide/dependabot.md @@ -3,8 +3,8 @@ Dependabot is automated dependency management tool. It is used to keep ROCm documentation dependencies up to date. -[Here is an example PR that dependabot made on the ROCm repository](https://github.com/RadeonOpenCompute/ROCm/pull/2273) +[Here is an example PR that dependabot made on the ROCm repository](https://github.com/ROCm/ROCm/pull/2273) -[Dependabot Configuration used by this project](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/.github/dependabot.yml) +[Dependabot Configuration used by this project](https://github.com/ROCm/rocm-docs-core/blob/develop/.github/dependabot.yml) [GitHub Dependabot Configuration Guide](https://docs.github.com/en/code-security/dependabot) diff --git a/docs/developer_guide/just.md b/docs/developer_guide/just.md index 208a36a3..07a12af1 100644 --- a/docs/developer_guide/just.md +++ b/docs/developer_guide/just.md @@ -36,6 +36,6 @@ Development container setup and settings are added for Visual Studio Development containers (and GitHub Codespaces) and Gitpod. - [VS Code Dev Containers Guide](https://code.visualstudio.com/docs/devcontainers/containers) - - [Dev Container Dockerfile and Configuration](https://github.com/RadeonOpenCompute/rocm-docs-core/tree/develop/.devcontainer) + - [Dev Container Dockerfile and Configuration](https://github.com/ROCm/rocm-docs-core/tree/develop/.devcontainer) - [Gitpod Guide](https://www.gitpod.io/docs/introduction/getting-started) - - [Gitpod Configuration](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/.gitpod.yml) + - [Gitpod Configuration](https://github.com/ROCm/rocm-docs-core/blob/develop/.gitpod.yml) diff --git a/docs/user_guide/doxygen_integration.md b/docs/user_guide/doxygen_integration.md index 27703bb4..e75bae1e 100644 --- a/docs/user_guide/doxygen_integration.md +++ b/docs/user_guide/doxygen_integration.md @@ -71,4 +71,4 @@ See the [source code](https://github.com/ROCm/rocm-docs-core) for details. The `tests` folder in the `rocm-docs-core` project on GitHub also has example configuration files. -See [this PR for a simple example of adding a Doxygen code snippet](https://github.com/RadeonOpenCompute/rocm-docs-core/pull/222). +See [this PR for a simple example of adding a Doxygen code snippet](https://github.com/ROCm/rocm-docs-core/pull/222). diff --git a/docs/user_guide/linking.md b/docs/user_guide/linking.md index c21f1776..b9f0ac68 100644 --- a/docs/user_guide/linking.md +++ b/docs/user_guide/linking.md @@ -11,7 +11,7 @@ format should be used: {doc}`Text here` ``` -The [`projects.yaml`](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/src/rocm_docs/data/projects.yaml) +The [`projects.yaml`](https://github.com/ROCm/rocm-docs-core/blob/develop/src/rocm_docs/data/projects.yaml) configuration file contains the names of projects that should be used when making links that cross-reference documentation sites. @@ -36,12 +36,12 @@ For other links, usual Markdown conventions should be used. The following Markdown: ```Markdown -[Link Text](https://github.com/RadeonOpenCompute/ROCm) +[Link Text](https://github.com/ROCm/ROCm) ``` will be rendered as the following link: -[Link Text](https://github.com/RadeonOpenCompute/ROCm) +[Link Text](https://github.com/ROCm/ROCm) #### Example: Relative Links to Current Project diff --git a/pyproject.toml b/pyproject.toml index ed7b3581..5a14bd03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,7 +36,7 @@ dependencies = [ requires-python = ">=3.10" [project.urls] -repository="https://github.com/RadeonOpenCompute/rocm-docs-core" +repository="https://github.com/ROCm/rocm-docs-core" documentation="https://docs.amd.com" [project.optional-dependencies] diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..5e5342bb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -47,7 +47,7 @@ click-log==0.4.0 # via doxysphinx colorama==0.4.6 # via commitizen -commitizen==3.26.0 +commitizen==3.27.0 # via rocm-docs-core (pyproject.toml) cryptography==42.0.7 # via pyjwt @@ -118,6 +118,8 @@ myst-parser==3.0.1 # via rocm-docs-core (pyproject.toml) nodeenv==1.9.0 # via pre-commit +numpy==1.26.4 + # via doxysphinx packaging==24.0 # via # black @@ -239,7 +241,6 @@ tomli==2.0.1 # build # mypy # pip-tools - # pyproject-hooks # pytest # sphinx tomlkit==0.12.5 diff --git a/src/rocm_docs/data/projects.schema.json b/src/rocm_docs/data/projects.schema.json index 969807b9..a5eab8e9 100644 --- a/src/rocm_docs/data/projects.schema.json +++ b/src/rocm_docs/data/projects.schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "$id": "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/develop/src/rocm_docs/data/projects.schema.json", + "$id": "https://raw.githubusercontent.com/ROCm/rocm-docs-core/develop/src/rocm_docs/data/projects.schema.json", "$defs": { "doxygen": { "type": ["object", "string"], diff --git a/src/rocm_docs/projects.py b/src/rocm_docs/projects.py index cea529f6..22b15108 100644 --- a/src/rocm_docs/projects.py +++ b/src/rocm_docs/projects.py @@ -40,7 +40,7 @@ Inventory: TypeAlias = str | None | tuple[str | None, ...] ProjectMapping: TypeAlias = tuple[str, Inventory] -DEFAULT_INTERSPHINX_REPOSITORY = "RadeonOpenCompute/rocm-docs-core" +DEFAULT_INTERSPHINX_REPOSITORY = "ROCm/rocm-docs-core" DEFAULT_INTERSPHINX_BRANCH = "develop" logger = sphinx.util.logging.getLogger(__name__) diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja index e0961f6a..683f618c 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja @@ -10,7 +10,7 @@ set repo_url = theme_repository_url|replace("-internal", "") {% set nav_secondary_items = { "GitHub": repo_url, - "Community": "https://github.com/RadeonOpenCompute/ROCm/discussions", + "Community": "https://github.com/ROCm/ROCm/discussions", "Documentation": "https://rocm.docs.amd.com/en/latest/", "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/rocm/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja index 6950861c..ca3f5c2b 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja @@ -26,7 +26,7 @@ {% set nav_secondary_items = { "GitHub": repo_url, - "Community": "https://github.com/RadeonOpenCompute/ROCm/discussions", + "Community": "https://github.com/ROCm/ROCm/discussions", "Blogs": "https://rocm.blogs.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/theme.py b/src/rocm_docs/theme.py index fb9a9fd9..79407e8b 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -125,11 +125,11 @@ def _update_theme_options(app: Sphinx) -> None: ) header_latest_version = _get_version_from_url( - "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/data/latest_version.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/latest_version.txt" ) header_release_candidate_version = _get_version_from_url( - "https://raw.githubusercontent.com/RadeonOpenCompute/rocm-docs-core/data/release_candidate.txt" + "https://raw.githubusercontent.com/ROCm/rocm-docs-core/data/release_candidate.txt" ) default_config_opts = { From 5a86147e3fc6203130113847e3ee546eeb564dd6 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Mon, 3 Jun 2024 14:45:34 -0600 Subject: [PATCH 05/14] docs(pyproject.toml): Update URL from docs.amd.com to rocm.docs.amd.com --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5a14bd03..b2bc948e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ requires-python = ">=3.10" [project.urls] repository="https://github.com/ROCm/rocm-docs-core" -documentation="https://docs.amd.com" +documentation="https://rocm.docs.amd.com" [project.optional-dependencies] api_reference = [ From de44dbaf49da1b5f8961b9fdc16f16f00ed8383a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 4 Jun 2024 16:24:12 +0000 Subject: [PATCH 06/14] build: bump pytest from 8.2.1 to 8.2.2 Bumps [pytest](https://github.com/pytest-dev/pytest) from 8.2.1 to 8.2.2. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](https://github.com/pytest-dev/pytest/compare/8.2.1...8.2.2) --- updated-dependencies: - dependency-name: pytest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..01a9c167 100644 --- a/requirements.txt +++ b/requirements.txt @@ -168,7 +168,7 @@ pyproject-hooks==1.1.0 # via # build # pip-tools -pytest==8.2.1 +pytest==8.2.2 # via rocm-docs-core (pyproject.toml) python-dateutil==2.9.0.post0 # via sphinxcontrib-doxylink From 359561fbea0b3fa0a60ba2ddbbcb55d7a98cd0da Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:50:27 +0000 Subject: [PATCH 07/14] build: bump cryptography from 42.0.7 to 42.0.8 Bumps [cryptography](https://github.com/pyca/cryptography) from 42.0.7 to 42.0.8. - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](https://github.com/pyca/cryptography/compare/42.0.7...42.0.8) --- updated-dependencies: - dependency-name: cryptography dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..d1e7150d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -49,7 +49,7 @@ colorama==0.4.6 # via commitizen commitizen==3.26.0 # via rocm-docs-core (pyproject.toml) -cryptography==42.0.7 +cryptography==42.0.8 # via pyjwt decli==0.6.2 # via commitizen From 5c0f5184086dd4164acf9d1e0bac83ec81740c1d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:50:40 +0000 Subject: [PATCH 08/14] build: bump ruff from 0.4.7 to 0.4.8 Bumps [ruff](https://github.com/astral-sh/ruff) from 0.4.7 to 0.4.8. - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](https://github.com/astral-sh/ruff/compare/v0.4.7...v0.4.8) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..723930c8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -185,7 +185,7 @@ requests==2.32.3 # via # pygithub # sphinx -ruff==0.4.7 +ruff==0.4.8 # via rocm-docs-core (pyproject.toml) six==1.16.0 # via python-dateutil From a4ae6dd7729da272c7069ceff09cde9603e6266c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:50:50 +0000 Subject: [PATCH 09/14] build: bump zipp from 3.19.1 to 3.19.2 Bumps [zipp](https://github.com/jaraco/zipp) from 3.19.1 to 3.19.2. - [Release notes](https://github.com/jaraco/zipp/releases) - [Changelog](https://github.com/jaraco/zipp/blob/main/NEWS.rst) - [Commits](https://github.com/jaraco/zipp/compare/v3.19.1...v3.19.2) --- updated-dependencies: - dependency-name: zipp dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..828a5269 100644 --- a/requirements.txt +++ b/requirements.txt @@ -264,7 +264,7 @@ wheel==0.43.0 # via pip-tools wrapt==1.16.0 # via deprecated -zipp==3.19.1 +zipp==3.19.2 # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: From d65b2654d0e2b76d3d9b77a68f95bc97d94958ed Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:50:59 +0000 Subject: [PATCH 10/14] build: bump nodeenv from 1.9.0 to 1.9.1 Bumps [nodeenv](https://github.com/ekalinin/nodeenv) from 1.9.0 to 1.9.1. - [Release notes](https://github.com/ekalinin/nodeenv/releases) - [Changelog](https://github.com/ekalinin/nodeenv/blob/master/CHANGES) - [Commits](https://github.com/ekalinin/nodeenv/compare/1.9.0...1.9.1) --- updated-dependencies: - dependency-name: nodeenv dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ccc1c68..25b18bbe 100644 --- a/requirements.txt +++ b/requirements.txt @@ -116,7 +116,7 @@ mypy-extensions==1.0.0 # mypy myst-parser==3.0.1 # via rocm-docs-core (pyproject.toml) -nodeenv==1.9.0 +nodeenv==1.9.1 # via pre-commit packaging==24.0 # via From a9e1c28b8d3eccd31105e7e91d1ee8c335a918d5 Mon Sep 17 00:00:00 2001 From: "amit.kumar6" Date: Sat, 1 Jun 2024 01:53:41 -0500 Subject: [PATCH 11/14] docs: Update feedback URL on Blog and ROCm portal --- src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja | 2 +- src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja index e0961f6a..6e4fb2f3 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja @@ -14,6 +14,6 @@ set nav_secondary_items = { "Documentation": "https://rocm.docs.amd.com/en/latest/", "Infinity Hub": "https://www.amd.com/en/developer/resources/infinity-hub.html", "Support": repo_url + "/issues/new/choose", - "Feedback": "mailto:rocm-feedback@amd.com" + "Feedback": "https://github.com/ROCm/ROCm/discussions/new/choose" } %} diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja index 6950861c..97370117 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja @@ -30,6 +30,6 @@ set nav_secondary_items = { "Blogs": "https://rocm.blogs.amd.com/", "Infinity Hub": "https://www.amd.com/en/developer/resources/infinity-hub.html", "Support": repo_url + "/issues/new/choose", - "Feedback": "mailto:rocm-feedback@amd.com" + "Feedback": "https://github.com/ROCm/ROCm/discussions/new/choose" } %} From 58feb672ae4e0897236495e6dc048f4419745547 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Wed, 5 Jun 2024 08:40:08 -0600 Subject: [PATCH 12/14] docs: Remove feedback from blogs header --- src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja index 6e4fb2f3..88e242b0 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm-blogs/header.jinja @@ -13,7 +13,6 @@ set nav_secondary_items = { "Community": "https://github.com/RadeonOpenCompute/ROCm/discussions", "Documentation": "https://rocm.docs.amd.com/en/latest/", "Infinity Hub": "https://www.amd.com/en/developer/resources/infinity-hub.html", - "Support": repo_url + "/issues/new/choose", - "Feedback": "https://github.com/ROCm/ROCm/discussions/new/choose" + "Support": repo_url + "/issues/new/choose" } %} From 6649f5ba5f4e49fcb5d7e2dcf26a29f52ceda424 Mon Sep 17 00:00:00 2001 From: Sam Wu <22262939+samjwu@users.noreply.github.com> Date: Wed, 5 Jun 2024 08:40:46 -0600 Subject: [PATCH 13/14] docs: Remove feedback from rocm header --- src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja index 97370117..1b182759 100644 --- a/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm/header.jinja @@ -29,7 +29,6 @@ set nav_secondary_items = { "Community": "https://github.com/RadeonOpenCompute/ROCm/discussions", "Blogs": "https://rocm.blogs.amd.com/", "Infinity Hub": "https://www.amd.com/en/developer/resources/infinity-hub.html", - "Support": repo_url + "/issues/new/choose", - "Feedback": "https://github.com/ROCm/ROCm/discussions/new/choose" + "Support": repo_url + "/issues/new/choose" } %} From 9f5e9e45f5656c28f6dc34eb1ab0c687f0fc676e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 6 Jun 2024 18:06:44 +0000 Subject: [PATCH 14/14] =?UTF-8?q?bump:=20version=201.3.0=20=E2=86=92=201.4?= =?UTF-8?q?.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 11 +++++++++++ docs/conf.py | 4 ++-- pyproject.toml | 4 ++-- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 917d4485..6ef61c4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,14 @@ +## v1.4.0 (2024-06-06) + +### Feat + +- Add google site verification content to theme context +- Add template for google site verification content + +### Refactor + +- Get versions from data branch instead of header-versions branch + ## v1.3.0 (2024-06-04) ### Feat diff --git a/docs/conf.py b/docs/conf.py index a4b441de..cc7b4dd1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,8 +37,8 @@ "path": "demo/doxygen/xml", } -version = "1.3.0" -release = "1.3.0" +version = "1.4.0" +release = "1.4.0" 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 b4b1c394..05421e36 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" [project] name = 'rocm-docs-core' -version = "1.3.0" +version = "1.4.0" authors=[ {name="Lauren Wrubleski", email="Lauren.Wrubleski@amd.com"} ] @@ -72,7 +72,7 @@ color = true [tool.commitizen] name = "cz_conventional_commits" -version = "1.3.0" +version = "1.4.0" version_files = ["pyproject.toml:^version", "docs/conf.py:^(version|release)"] tag_format = "v$version" annotated_tag = true