Skip to content

Commit 7add057

Browse files
AMD-melliotty2kenny-amd
authored andcommitted
Updated sphinx config and TOC
1 parent f5ca808 commit 7add057

File tree

2 files changed

+32
-13
lines changed

2 files changed

+32
-13
lines changed

docs/conf.py

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,29 @@
44
# list see the documentation:
55
# https://www.sphinx-doc.org/en/master/usage/configuration.html
66

7-
# configurations for PDF output by Read the Docs
8-
project = "k8s-device-plugin Documentation"
9-
author = "Advanced Micro Devices, Inc."
10-
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
11-
version = "6.2.0"
12-
release = "6.2.0"
137

14-
external_toc_path = "./sphinx/_toc.yml"
8+
external_projects_local_file = "projects.yaml"
9+
external_projects_remote_repository = ""
10+
#external_projects = ["k8s-device-plugin"]
11+
external_projects = []
12+
external_projects_current_project = "k8s-device-plugin"
13+
14+
project = "AMD Kubernetes Device Plugin Documentation"
15+
version = "1.3.1"
16+
release = version
17+
html_title = f"Device Plugin Documentation {version}"
18+
author = "Advanced Micro Devices, Inc."
19+
copyright = "Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved."
1520

21+
# Required settings
22+
html_theme = "rocm_docs_theme"
23+
html_theme_options = {
24+
"flavor": "instinct"
25+
}
1626
extensions = ["rocm_docs"]
1727

18-
external_projects_current_project = "rocm"
28+
external_toc_path = "./sphinx/_toc.yml"
1929

20-
html_theme = "rocm_docs_theme"
21-
html_theme_options = {"flavor": "rocm-docs-home"}
30+
extensions = ["rocm_docs"]
2231

23-
html_title = project
32+
exclude_patterns = ['.venv']

docs/sphinx/_toc.yml.in

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ defaults:
33
maxdepth: 6
44
root: index
55
subtrees:
6-
- caption: About
6+
- caption: User Guide
77
entries:
8-
- file: about/license
8+
- file: user-guide/installation
9+
- file: user-guide/configuration
10+
- file: user-guide/examples
11+
- caption: Advanced
12+
entries:
13+
- file: advanced/health-checks
14+
- file: advanced/monitoring
15+
- file: advanced/node-labelling
16+
- caption: Contributing
17+
entries:
18+
- file: contributing/development

0 commit comments

Comments
 (0)