mirror of
https://github.com/ROCm/ROCm.git
synced 2026-01-09 06:38:00 -05:00
e87dba01c6
Flattened out page structure for improved navigability. * Change Table of Contents * Update the install guides for windows and linux * Removed extraneous index pages * GPU architecture pages duplicate entries removed * spack page cleanup --------- Co-authored-by: Sam Wu <samwu103@amd.com> Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com>
84 lines
2.7 KiB
Python
84 lines
2.7 KiB
Python
# 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
|
|
|
|
import shutil
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
|
|
shutil.copy2('../CONTRIBUTING.md','./contribute/index.md')
|
|
shutil.copy2('../RELEASE.md','./about/release-notes.md')
|
|
# Keep capitalization due to similar linking on GitHub's markdown preview.
|
|
shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
|
|
|
|
latex_engine = "xelatex"
|
|
|
|
# configurations for PDF output by Read the Docs
|
|
project = "ROCm Documentation"
|
|
author = "Advanced Micro Devices, Inc."
|
|
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
|
|
version = "5.7.0"
|
|
release = "5.7.0"
|
|
|
|
setting_all_article_info = True
|
|
all_article_info_os = ["linux", "windows"]
|
|
all_article_info_author = ""
|
|
|
|
# pages with specific settings
|
|
article_pages = [
|
|
{
|
|
"file":"release",
|
|
"os":["linux", "windows"],
|
|
"date":"2023-07-27"
|
|
},
|
|
|
|
{"file":"install/windows/install-quick", "os":["windows"]},
|
|
{"file":"install/linux/install-quick", "os":["linux"]},
|
|
|
|
{"file":"install/linux/install", "os":["linux"]},
|
|
{"file":"install/linux/install-options", "os":["linux"]},
|
|
{"file":"install/linux/prerequisites", "os":["linux"]},
|
|
|
|
{"file":"install/docker", "os":["linux"]},
|
|
{"file":"install/magma-install", "os":["linux"]},
|
|
{"file":"install/pytorch-install", "os":["linux"]},
|
|
{"file":"install/tensorflow-install", "os":["linux"]},
|
|
|
|
{"file":"install/windows/install", "os":["windows"]},
|
|
{"file":"install/windows/prerequisites", "os":["windows"]},
|
|
{"file":"install/windows/cli/index", "os":["windows"]},
|
|
{"file":"install/windows/gui/index", "os":["windows"]},
|
|
|
|
{"file":"about/compatibility/linux-support", "os":["linux"]},
|
|
{"file":"about/compatibility/windows-support", "os":["windows"]},
|
|
|
|
{"file":"about/compatibility/docker-image-support-matrix", "os":["linux"]},
|
|
{"file":"about/compatibility/user-kernel-space-compat-matrix", "os":["linux"]},
|
|
|
|
{"file":"reference/library-index", "os":["linux"]},
|
|
|
|
{"file":"how-to/deep-learning-rocm", "os":["linux"]},
|
|
{"file":"how-to/gpu-enabled-mpi", "os":["linux"]},
|
|
{"file":"how-to/system-debugging", "os":["linux"]},
|
|
{"file":"how-to/tuning-guides", "os":["linux", "windows"]},
|
|
|
|
{"file":"rocm-a-z", "os":["linux", "windows"]},
|
|
|
|
]
|
|
|
|
external_toc_path = "./sphinx/_toc.yml"
|
|
|
|
docs_core = ROCmDocs("ROCm Documentation")
|
|
docs_core.setup()
|
|
|
|
external_projects_current_project = "rocm"
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
|
html_theme_options = {
|
|
"link_main_doc": False
|
|
}
|