Apply doc standards for ReadtheDocs builds
Applies the following changes:
add version number to documentation left navigation bar and page title
add an "About" section with a license page
enable htmlzip, pdf, epub formats when publishing on Read the Docs
set pdf title, author, copyright, and version
rename .sphinx/.doxygen to sphinx/doxygen
remove docBin from URL
update rocm-docs-core dependency
Change-Id: I947cf32cd42d9f4e55b1ddd324ad4a7e4ba3f3e3
[ROCm/ROCR-Runtime commit: 1c6ad56dc6]
This commit is contained in:
Sam Wu
Sam Wu
@@ -0,0 +1,18 @@
|
||||
# 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"
|
||||
@@ -0,0 +1,78 @@
|
||||
API
|
||||
===
|
||||
|
||||
:ref:`genindex`
|
||||
|
||||
:ref:`search`
|
||||
|
||||
Architected Queuing Language
|
||||
############################
|
||||
.. doxygengroup:: aql
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Code Objects [**DEPRECATED**]
|
||||
#############################
|
||||
.. doxygengroup:: code-object
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Executable
|
||||
##########
|
||||
.. doxygengroup:: executable
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Finalization Extensions
|
||||
#######################
|
||||
.. doxygengroup:: ext-alt-finalizer-extensions
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Finalization Program
|
||||
####################
|
||||
.. doxygengroup:: ext-alt-finalizer-program
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Images And Samplers
|
||||
###################
|
||||
.. doxygengroup:: ext-images
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Instruction Set Architecture
|
||||
############################
|
||||
.. doxygengroup:: instruction-set-architecture
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Memory
|
||||
######
|
||||
.. doxygengroup:: memory
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Queues
|
||||
######
|
||||
.. doxygengroup:: queue
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Runtime Notifications
|
||||
#####################
|
||||
.. doxygengroup:: status
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
Signals
|
||||
#######
|
||||
.. doxygengroup:: signals
|
||||
:content-only:
|
||||
:inner:
|
||||
|
||||
System And Agent Information
|
||||
############################
|
||||
.. doxygengroup:: agentinfo
|
||||
:content-only:
|
||||
:inner:
|
||||
@@ -0,0 +1,36 @@
|
||||
# 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 os
|
||||
import re
|
||||
|
||||
from rocm_docs import ROCmDocs
|
||||
|
||||
os.system("cp ../README.md index.md")
|
||||
os.system("cp ../src/README.md structure.md")
|
||||
|
||||
with open('../src/CMakeLists.txt', encoding='utf-8') as f:
|
||||
match = re.search(r'get_version \(\s+\"?([0-9.]+)[^0-9.]+', f.read())
|
||||
if not match:
|
||||
raise ValueError("VERSION not found!")
|
||||
version_number = match[1]
|
||||
left_nav_title = f"ROCR {version_number} Documentation"
|
||||
|
||||
# for PDF output on Read the Docs
|
||||
project = "ROCR Documentation"
|
||||
author = "Advanced Micro Devices, Inc."
|
||||
copyright = "Copyright (c) 2024 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()
|
||||
|
||||
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
||||
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
||||
File diff ditekan karena terlalu besar
Load Diff
@@ -0,0 +1,23 @@
|
||||
# Environment Variables
|
||||
|
||||
## HSA_ENABLE_SDMA
|
||||
|
||||
Possible values:
|
||||
|
||||
* 0:Disabled
|
||||
* 1:Enabled (Default Value)
|
||||
|
||||
This will enable or disable the use of DMA engines in all copy directions (Host-to-Device, Device-to-Host, Device-to-Device) when using the following APIs:
|
||||
`hsa_memory_copy`, `hsa_amd_memory_fill`, `hsa_amd_memory_async_copy`, `hsa_amd_memory_async_copy_on_engine`
|
||||
|
||||
## HSA_ENABLE_PEER_SDMA
|
||||
|
||||
Possible values:
|
||||
|
||||
* 0:Disabled
|
||||
* 1:Enabled (Default Value)
|
||||
|
||||
This will enable or disable the use of DMA engines for Device-to-Device copies when using the following APIs:
|
||||
`hsa_memory_copy`, `hsa_amd_memory_async_copy`, `hsa_amd_memory_async_copy_on_engine`
|
||||
|
||||
The value of `HSA_ENABLE_PEER_SDMA` is ignored if `HSA_ENABLE_SDMA` is used to disable the use of DMA engines.
|
||||
@@ -0,0 +1,4 @@
|
||||
License
|
||||
=======
|
||||
|
||||
.. include:: ../LICENSE.txt
|
||||
@@ -0,0 +1,12 @@
|
||||
# Anywhere {branch} is used, the branch name will be substituted.
|
||||
# These comments will also be removed.
|
||||
root: index
|
||||
subtrees:
|
||||
- numbered: False
|
||||
entries:
|
||||
- file: structure
|
||||
- file: api
|
||||
- file: environment_variables
|
||||
- caption: About
|
||||
entries:
|
||||
- file: license
|
||||
@@ -0,0 +1 @@
|
||||
rocm-docs-core>=0.31.0
|
||||
@@ -0,0 +1,153 @@
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.8
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile requirements.in
|
||||
#
|
||||
accessible-pygments==0.0.4
|
||||
# via pydata-sphinx-theme
|
||||
alabaster==0.7.13
|
||||
# via sphinx
|
||||
babel==2.12.1
|
||||
# via
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
beautifulsoup4==4.12.2
|
||||
# via pydata-sphinx-theme
|
||||
breathe==4.34.0
|
||||
# via rocm-docs-core
|
||||
certifi==2022.12.7
|
||||
# via requests
|
||||
cffi==1.15.1
|
||||
# via
|
||||
# cryptography
|
||||
# pynacl
|
||||
charset-normalizer==3.1.0
|
||||
# via requests
|
||||
click==8.1.3
|
||||
# via sphinx-external-toc
|
||||
cryptography==40.0.2
|
||||
# via pyjwt
|
||||
deprecated==1.2.13
|
||||
# via pygithub
|
||||
docutils==0.16
|
||||
# via
|
||||
# breathe
|
||||
# myst-parser
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
fastjsonschema==2.19.1
|
||||
# via rocm-docs-core
|
||||
gitdb==4.0.10
|
||||
# via gitpython
|
||||
gitpython==3.1.31
|
||||
# via rocm-docs-core
|
||||
idna==3.4
|
||||
# via requests
|
||||
imagesize==1.4.1
|
||||
# via sphinx
|
||||
importlib-metadata==6.3.0
|
||||
# via sphinx
|
||||
importlib-resources==5.12.0
|
||||
# via rocm-docs-core
|
||||
jinja2==3.1.2
|
||||
# via
|
||||
# myst-parser
|
||||
# sphinx
|
||||
markdown-it-py==2.2.0
|
||||
# via
|
||||
# mdit-py-plugins
|
||||
# myst-parser
|
||||
markupsafe==2.1.2
|
||||
# via jinja2
|
||||
mdit-py-plugins==0.3.5
|
||||
# via myst-parser
|
||||
mdurl==0.1.2
|
||||
# via markdown-it-py
|
||||
myst-parser==1.0.0
|
||||
# via rocm-docs-core
|
||||
packaging==23.0
|
||||
# via
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
pycparser==2.21
|
||||
# via cffi
|
||||
pydata-sphinx-theme==0.13.3
|
||||
# via
|
||||
# rocm-docs-core
|
||||
# sphinx-book-theme
|
||||
pygithub==1.58.1
|
||||
# via rocm-docs-core
|
||||
pygments==2.15.0
|
||||
# via
|
||||
# accessible-pygments
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
pyjwt[crypto]==2.6.0
|
||||
# via
|
||||
# pygithub
|
||||
# pyjwt
|
||||
pynacl==1.5.0
|
||||
# via pygithub
|
||||
pytz==2023.3
|
||||
# via babel
|
||||
pyyaml==6.0
|
||||
# via
|
||||
# myst-parser
|
||||
# rocm-docs-core
|
||||
# sphinx-external-toc
|
||||
requests==2.28.2
|
||||
# via
|
||||
# pygithub
|
||||
# sphinx
|
||||
rocm-docs-core==0.31.0
|
||||
# via -r requirements.in
|
||||
smmap==5.0.0
|
||||
# via gitdb
|
||||
snowballstemmer==2.2.0
|
||||
# via sphinx
|
||||
soupsieve==2.4
|
||||
# via beautifulsoup4
|
||||
sphinx==5.3.0
|
||||
# via
|
||||
# breathe
|
||||
# myst-parser
|
||||
# pydata-sphinx-theme
|
||||
# rocm-docs-core
|
||||
# sphinx-book-theme
|
||||
# sphinx-copybutton
|
||||
# sphinx-design
|
||||
# sphinx-external-toc
|
||||
# sphinx-notfound-page
|
||||
sphinx-book-theme==1.0.1
|
||||
# via rocm-docs-core
|
||||
sphinx-copybutton==0.5.1
|
||||
# via rocm-docs-core
|
||||
sphinx-design==0.3.0
|
||||
# via rocm-docs-core
|
||||
sphinx-external-toc==0.3.1
|
||||
# via rocm-docs-core
|
||||
sphinx-notfound-page==0.8.3
|
||||
# via rocm-docs-core
|
||||
sphinxcontrib-applehelp==1.0.4
|
||||
# via sphinx
|
||||
sphinxcontrib-devhelp==1.0.2
|
||||
# via sphinx
|
||||
sphinxcontrib-htmlhelp==2.0.1
|
||||
# via sphinx
|
||||
sphinxcontrib-jsmath==1.0.1
|
||||
# via sphinx
|
||||
sphinxcontrib-qthelp==1.0.3
|
||||
# via sphinx
|
||||
sphinxcontrib-serializinghtml==1.1.5
|
||||
# via sphinx
|
||||
typing-extensions==4.5.0
|
||||
# via pydata-sphinx-theme
|
||||
urllib3==1.26.15
|
||||
# via requests
|
||||
wrapt==1.15.0
|
||||
# via deprecated
|
||||
zipp==3.15.0
|
||||
# via
|
||||
# importlib-metadata
|
||||
# importlib-resources
|
||||
Reference in New Issue
Block a user