Skip to content

Commit

Permalink
Standardize documentation
Browse files Browse the repository at this point in the history
Applies changes noted in ROCm/rocm-docs-core#330
  • Loading branch information
samjwu committed Oct 19, 2023
1 parent 79a3a00 commit b244bdf
Show file tree
Hide file tree
Showing 10 changed files with 2,698 additions and 2,656 deletions.
30 changes: 18 additions & 12 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/docs/.sphinx" # Location of package manifests
open-pull-requests-limit: 10
schedule:
interval: "daily"
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/docs/sphinx" # Location of package manifests
open-pull-requests-limit: 10
schedule:
interval: "daily"
labels:
- "documentation"
- "dependencies"
- "ci:docs-only"
reviewers:
- "samjwu"
40 changes: 20 additions & 20 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
configuration: docs/conf.py

formats: [htmlzip, pdf, epub]

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

build:
os: ubuntu-20.04
tools:
python: "3.8"
apt_packages:
- "doxygen"
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
configuration: docs/conf.py

formats: [htmlzip, pdf, epub]

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

build:
os: ubuntu-22.04
tools:
python: "3.8"
apt_packages:
- "doxygen"
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_doxygen/
1 change: 0 additions & 1 deletion docs/.sphinx/requirements.in

This file was deleted.

46 changes: 32 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

from rocm_docs import ROCmDocs

docs_core = ROCmDocs("TransferBench Documentation")
docs_core.setup()
docs_core.run_doxygen()

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

from rocm_docs import ROCmDocs

with open('../CMakeLists.txt', encoding='utf-8') as f:
match = re.search(r'#define TB_VERSION "([0-9.]+)[^0-9.]+', f.read())
if not match:
raise ValueError("VERSION not found!")
version_number = match[1]
left_nav_title = f"TransferBench {version_number} Documentation"

# for PDF output on Read the Docs
project = "TransferBench 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.setup()

external_projects_current_project = "transferbench"

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

0 comments on commit b244bdf

Please sign in to comment.