Skip to content

Commit f67bc83

Browse files
saadrahimlawruble13samjwu
authored
[HIPIFY][doc] Building Documentation on RTD (#737)
* documentation build --------- Co-authored-by: Lauren Wrubleski <[email protected]> Co-authored-by: Sam Wu <[email protected]>
1 parent af24aba commit f67bc83

26 files changed

+1081
-674
lines changed

‎.github/dependabot.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "pip" # See documentation for possible values
9+
directory: "/docs/.sphinx" # Location of package manifests
10+
open-pull-requests-limit: 10
11+
schedule:
12+
interval: "daily"

‎.github/workflows/markdownlint.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Markdownlint mdl Action
2+
on: push
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Check out code
9+
uses: actions/checkout@v3
10+
- name: Use markdownlint
11+
uses: actionshub/[email protected]
12+
with:
13+
filesToIgnoreRegex: "README.md"

‎.gitignore

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
*.json
2-
*.hip
2+
*.hip
3+
**/__pycache__/*
4+
.python-version
5+
6+
# documentation artifacts
7+
build/
8+
_build/
9+
_images/
10+
_static/
11+
_templates/
12+
_toc.yml
13+
docBin/

‎.mdlrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
style "mdlrc-style.rb"

‎.readthedocs.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
sphinx:
7+
configuration: docs/conf.py
8+
9+
formats: [htmlzip]
10+
11+
python:
12+
version: "3.8"
13+
install:
14+
- requirements: docs/.sphinx/requirements.txt

‎README.md

+8-673
Large diffs are not rendered by default.

‎docs/.sphinx/_toc.yml.in

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Anywhere {branch} is used, the branch name will be substituted.
2+
# These comments will also be removed.
3+
defaults:
4+
numbered: False
5+
root: index
6+
subtrees:
7+
- entries:
8+
- file: hipify-clang
9+
- file: hipify-perl
10+
- file: supported_apis
11+
subtrees:
12+
- entries:
13+
- file: tables/CUDA_Runtime_API_functions_supported_by_HIP
14+
- file: tables/CUDA_Driver_API_functions_supported_by_HIP
15+
- file: tables/cuComplex_API_supported_by_HIP
16+
- file: tables/CUDA_Device_API_supported_by_HIP
17+
- file: tables/CUDA_RTC_API_supported_by_HIP
18+
- file: tables/CUBLAS_API_supported_by_HIP
19+
- file: tables/CURAND_API_supported_by_HIP
20+
- file: tables/CUDNN_API_supported_by_HIP
21+
- file: tables/CUFFT_API_supported_by_HIP
22+
- file: tables/CUSPARSE_API_supported_by_HIP
23+
- file: tables/CUB_API_supported_by_HIP
24+

‎docs/.sphinx/requirements.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
rocm-docs-core==0.2.0

‎docs/.sphinx/requirements.txt

+271
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,271 @@
1+
#
2+
# This file is autogenerated by pip-compile with Python 3.10
3+
# by the following command:
4+
#
5+
# pip-compile .sphinx/requirements.in
6+
#
7+
accessible-pygments==0.0.3
8+
# via pydata-sphinx-theme
9+
alabaster==0.7.12
10+
# via sphinx
11+
asttokens==2.2.1
12+
# via stack-data
13+
attrs==22.2.0
14+
# via
15+
# jsonschema
16+
# jupyter-cache
17+
babel==2.11.0
18+
# via
19+
# pydata-sphinx-theme
20+
# sphinx
21+
backcall==0.2.0
22+
# via ipython
23+
beautifulsoup4==4.11.1
24+
# via pydata-sphinx-theme
25+
breathe==4.34.0
26+
# via rocm-docs-core
27+
certifi==2022.12.7
28+
# via requests
29+
cffi==1.15.1
30+
# via pynacl
31+
charset-normalizer==2.1.1
32+
# via requests
33+
click==8.1.3
34+
# via
35+
# jupyter-cache
36+
# sphinx-external-toc
37+
comm==0.1.2
38+
# via ipykernel
39+
debugpy==1.6.4
40+
# via ipykernel
41+
decorator==5.1.1
42+
# via ipython
43+
deprecated==1.2.13
44+
# via pygithub
45+
docutils==0.16
46+
# via
47+
# breathe
48+
# myst-parser
49+
# pydata-sphinx-theme
50+
# rocm-docs-core
51+
# sphinx
52+
entrypoints==0.4
53+
# via jupyter-client
54+
executing==1.2.0
55+
# via stack-data
56+
fastjsonschema==2.16.2
57+
# via nbformat
58+
gitdb==4.0.10
59+
# via gitpython
60+
gitpython==3.1.30
61+
# via rocm-docs-core
62+
greenlet==2.0.1
63+
# via sqlalchemy
64+
idna==3.4
65+
# via requests
66+
imagesize==1.4.1
67+
# via sphinx
68+
importlib-metadata==6.0.0
69+
# via
70+
# jupyter-cache
71+
# myst-nb
72+
ipykernel==6.19.4
73+
# via myst-nb
74+
ipython==8.7.0
75+
# via
76+
# ipykernel
77+
# myst-nb
78+
jedi==0.18.2
79+
# via ipython
80+
jinja2==3.1.2
81+
# via
82+
# myst-parser
83+
# sphinx
84+
jsonschema==4.17.3
85+
# via nbformat
86+
jupyter-cache==0.5.0
87+
# via myst-nb
88+
jupyter-client==7.4.8
89+
# via
90+
# ipykernel
91+
# nbclient
92+
jupyter-core==5.1.2
93+
# via
94+
# jupyter-client
95+
# nbformat
96+
linkify-it-py==1.0.3
97+
# via myst-parser
98+
markdown-it-py==2.1.0
99+
# via
100+
# mdit-py-plugins
101+
# myst-parser
102+
markupsafe==2.1.1
103+
# via jinja2
104+
matplotlib-inline==0.1.6
105+
# via
106+
# ipykernel
107+
# ipython
108+
mdit-py-plugins==0.3.3
109+
# via myst-parser
110+
mdurl==0.1.2
111+
# via markdown-it-py
112+
myst-nb==0.17.1
113+
# via rocm-docs-core
114+
myst-parser[linkify]==0.18.1
115+
# via
116+
# myst-nb
117+
# rocm-docs-core
118+
nbclient==0.5.13
119+
# via
120+
# jupyter-cache
121+
# myst-nb
122+
nbformat==5.7.1
123+
# via
124+
# jupyter-cache
125+
# myst-nb
126+
# nbclient
127+
nest-asyncio==1.5.6
128+
# via
129+
# ipykernel
130+
# jupyter-client
131+
# nbclient
132+
packaging==22.0
133+
# via
134+
# ipykernel
135+
# pydata-sphinx-theme
136+
# sphinx
137+
parso==0.8.3
138+
# via jedi
139+
pexpect==4.8.0
140+
# via ipython
141+
pickleshare==0.7.5
142+
# via ipython
143+
platformdirs==2.6.2
144+
# via jupyter-core
145+
prompt-toolkit==3.0.36
146+
# via ipython
147+
psutil==5.9.4
148+
# via ipykernel
149+
ptyprocess==0.7.0
150+
# via pexpect
151+
pure-eval==0.2.2
152+
# via stack-data
153+
pycparser==2.21
154+
# via cffi
155+
pydata-sphinx-theme==0.13.1
156+
# via sphinx-book-theme
157+
pygithub==1.57
158+
# via rocm-docs-core
159+
pygments==2.14.0
160+
# via
161+
# accessible-pygments
162+
# ipython
163+
# pydata-sphinx-theme
164+
# sphinx
165+
pyjwt==2.6.0
166+
# via pygithub
167+
pynacl==1.5.0
168+
# via pygithub
169+
pyrsistent==0.19.3
170+
# via jsonschema
171+
python-dateutil==2.8.2
172+
# via jupyter-client
173+
pytz==2022.7
174+
# via babel
175+
pyyaml==6.0
176+
# via
177+
# jupyter-cache
178+
# myst-nb
179+
# myst-parser
180+
# sphinx-external-toc
181+
pyzmq==24.0.1
182+
# via
183+
# ipykernel
184+
# jupyter-client
185+
requests==2.28.1
186+
# via
187+
# pygithub
188+
# sphinx
189+
rocm-docs-core==0.2.0
190+
# via -r .sphinx/requirements.in
191+
six==1.16.0
192+
# via
193+
# asttokens
194+
# python-dateutil
195+
smmap==5.0.0
196+
# via gitdb
197+
snowballstemmer==2.2.0
198+
# via sphinx
199+
soupsieve==2.3.2.post1
200+
# via beautifulsoup4
201+
sphinx==4.3.1
202+
# via
203+
# breathe
204+
# myst-nb
205+
# myst-parser
206+
# pydata-sphinx-theme
207+
# rocm-docs-core
208+
# sphinx-book-theme
209+
# sphinx-copybutton
210+
# sphinx-design
211+
# sphinx-external-toc
212+
# sphinx-notfound-page
213+
sphinx-book-theme==1.0.0rc2
214+
# via rocm-docs-core
215+
sphinx-copybutton==0.5.1
216+
# via rocm-docs-core
217+
sphinx-design==0.3.0
218+
# via rocm-docs-core
219+
sphinx-external-toc==0.3.1
220+
# via rocm-docs-core
221+
sphinx-notfound-page==0.8.3
222+
# via rocm-docs-core
223+
sphinxcontrib-applehelp==1.0.2
224+
# via sphinx
225+
sphinxcontrib-devhelp==1.0.2
226+
# via sphinx
227+
sphinxcontrib-htmlhelp==2.0.0
228+
# via sphinx
229+
sphinxcontrib-jsmath==1.0.1
230+
# via sphinx
231+
sphinxcontrib-qthelp==1.0.3
232+
# via sphinx
233+
sphinxcontrib-serializinghtml==1.1.5
234+
# via sphinx
235+
sqlalchemy==1.4.45
236+
# via jupyter-cache
237+
stack-data==0.6.2
238+
# via ipython
239+
tabulate==0.9.0
240+
# via jupyter-cache
241+
tornado==6.2
242+
# via
243+
# ipykernel
244+
# jupyter-client
245+
traitlets==5.8.0
246+
# via
247+
# comm
248+
# ipykernel
249+
# ipython
250+
# jupyter-client
251+
# jupyter-core
252+
# matplotlib-inline
253+
# nbclient
254+
# nbformat
255+
typing-extensions==4.4.0
256+
# via
257+
# myst-nb
258+
# myst-parser
259+
uc-micro-py==1.0.1
260+
# via linkify-it-py
261+
urllib3==1.26.13
262+
# via requests
263+
wcwidth==0.2.5
264+
# via prompt-toolkit
265+
wrapt==1.14.1
266+
# via deprecated
267+
zipp==3.11.0
268+
# via importlib-metadata
269+
270+
# The following packages are considered to be unsafe in a requirements file:
271+
# setuptools

‎docs/conf.py

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
from rocm_docs import ROCmDocs
8+
9+
docs_core = ROCmDocs("HIPIFY Documentation")
10+
docs_core.setup()
11+
12+
for sphinx_var in ROCmDocs.SPHINX_VARS:
13+
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

0 commit comments

Comments
 (0)