-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
22dc463
commit a4ab29c
Showing
59 changed files
with
5,892 additions
and
513 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
Oops, something went wrong.