1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
rocm for Debian
---------------
When generating the doc we use:
ROCM_DOCS_REMOTE_DETAILS="$url,$branch" ;
url=https://github.com/ROCm/rocm
branch=latest
When using non github provider:
url=https://salsa.debian.org/rocm/rocm
branch=master
# you need to add some parameter for custom provider in docs/conf.py
cat >> docs/conf.py <<-EOF
# Specify that you are using a custom provider
html_theme_options = {
"repository_provider": "custom",
# Common options for rocm_docs_theme and sphinx_book_theme
"repository_url": "$url",
"repository_branch": "$branch",
"path_to_docs": "docs",
# Specific options for rocm_docs_theme
"header_name": "ROCm Documentation", # Displayed project name
"show_version": True, # Display project version
"show_branch": True, # Display current branch
"sidebar_main_pages": "index", # Make file for navigation
# Other options can apply with theme update
}
# The linkcode_resolve function is now handled by the theme
# So you don't need to write one unless you want more custom links
EOF
|
