Skip to content

Commit 36b33c6

Browse files
david-salinasdavid-salinas
authored
Merge pull request #64 from samjwu/rtd
Documentation - Add sphinx configs for Read the Docs/RTD
2 parents cd7e40f + 771c464 commit 36b33c6

13 files changed

+384
-3
lines changed

‎amd/hipcc/.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"

‎amd/hipcc/.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,13 @@
55

66
# Nested build directory.
77
/build*
8+
9+
# documentation artifacts
10+
build/
11+
_build/
12+
_images/
13+
_static/
14+
_templates/
15+
_toc.yml
16+
docBin/
17+
_doxygen/

‎amd/hipcc/.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

‎amd/hipcc/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@
55
<!-- toc -->
66

77
- [hipcc](#hipcc)
8+
* [Documentation](#documentation)
89
* [Environment Variables](#envVar)
910
* [Usage](#hipcc-usage)
1011
* [Building](#building)
1112
* [Testing](#testing)
12-
* [Linux](#linux)
13-
* [Windows](#windows)
1413

1514
<!-- tocstop -->
1615

@@ -20,6 +19,18 @@
2019

2120
`hipcc` will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler.
2221

22+
## Documentation
23+
24+
Run the steps below to build documentation locally.
25+
26+
```
27+
cd docs
28+
29+
pip3 install -r .sphinx/requirements.txt
30+
31+
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
32+
```
33+
2334
### <a name="envVar"></a> Environment Variables
2435

2536
The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
@@ -63,4 +74,4 @@ The hipcc and hipconfig executables are created in the current build folder. The
6374

6475
### <a name="testing"></a> hipcc: testing
6576

66-
Currently hipcc/hipconfig executables are tested by building and executing HIP tests. Seperate tests for hipcc/hipconfig is currently not planned.
77+
Currently hipcc/hipconfig executables are tested by building and executing HIP tests. Separate tests for hipcc/hipconfig is currently not planned.

‎amd/hipcc/docs/.sphinx/_toc.yml.in

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Anywhere {branch} is used, the branch name will be substituted.
2+
# These comments will also be removed.
3+
root: index
4+
subtrees:
5+
- numbered: False
6+
entries:
7+
- file: env
8+
- file: usage
9+
- file: build
10+
- file: test

‎amd/hipcc/docs/.sphinx/requirements.in

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

‎amd/hipcc/docs/.sphinx/requirements.txt

+268
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
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.4
8+
# via pydata-sphinx-theme
9+
alabaster==0.7.13
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.12.1
18+
# via
19+
# pydata-sphinx-theme
20+
# sphinx
21+
backcall==0.2.0
22+
# via ipython
23+
beautifulsoup4==4.12.2
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==3.1.0
32+
# via requests
33+
click==8.1.3
34+
# via
35+
# jupyter-cache
36+
# sphinx-external-toc
37+
comm==0.1.3
38+
# via ipykernel
39+
debugpy==1.6.7
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+
executing==1.2.0
53+
# via stack-data
54+
fastjsonschema==2.16.3
55+
# via nbformat
56+
gitdb==4.0.10
57+
# via gitpython
58+
gitpython==3.1.31
59+
# via rocm-docs-core
60+
greenlet==2.0.2
61+
# via sqlalchemy
62+
idna==3.4
63+
# via requests
64+
imagesize==1.4.1
65+
# via sphinx
66+
importlib-metadata==6.3.0
67+
# via
68+
# jupyter-cache
69+
# myst-nb
70+
ipykernel==6.22.0
71+
# via myst-nb
72+
ipython==8.12.0
73+
# via
74+
# ipykernel
75+
# myst-nb
76+
jedi==0.18.2
77+
# via ipython
78+
jinja2==3.1.2
79+
# via
80+
# myst-parser
81+
# sphinx
82+
jsonschema==4.17.3
83+
# via nbformat
84+
jupyter-cache==0.5.0
85+
# via myst-nb
86+
jupyter-client==8.1.0
87+
# via
88+
# ipykernel
89+
# nbclient
90+
jupyter-core==5.3.0
91+
# via
92+
# ipykernel
93+
# jupyter-client
94+
# nbformat
95+
linkify-it-py==1.0.3
96+
# via myst-parser
97+
markdown-it-py==2.2.0
98+
# via
99+
# mdit-py-plugins
100+
# myst-parser
101+
markupsafe==2.1.2
102+
# via jinja2
103+
matplotlib-inline==0.1.6
104+
# via
105+
# ipykernel
106+
# ipython
107+
mdit-py-plugins==0.3.5
108+
# via myst-parser
109+
mdurl==0.1.2
110+
# via markdown-it-py
111+
myst-nb==0.17.1
112+
# via rocm-docs-core
113+
myst-parser[linkify]==0.18.1
114+
# via
115+
# myst-nb
116+
# rocm-docs-core
117+
nbclient==0.5.13
118+
# via
119+
# jupyter-cache
120+
# myst-nb
121+
nbformat==5.8.0
122+
# via
123+
# jupyter-cache
124+
# myst-nb
125+
# nbclient
126+
nest-asyncio==1.5.6
127+
# via
128+
# ipykernel
129+
# nbclient
130+
packaging==23.1
131+
# via
132+
# ipykernel
133+
# pydata-sphinx-theme
134+
# sphinx
135+
parso==0.8.3
136+
# via jedi
137+
pexpect==4.8.0
138+
# via ipython
139+
pickleshare==0.7.5
140+
# via ipython
141+
platformdirs==3.2.0
142+
# via jupyter-core
143+
prompt-toolkit==3.0.38
144+
# via ipython
145+
psutil==5.9.4
146+
# via ipykernel
147+
ptyprocess==0.7.0
148+
# via pexpect
149+
pure-eval==0.2.2
150+
# via stack-data
151+
pycparser==2.21
152+
# via cffi
153+
pydata-sphinx-theme==0.13.3
154+
# via sphinx-book-theme
155+
pygithub==1.57
156+
# via rocm-docs-core
157+
pygments==2.15.0
158+
# via
159+
# accessible-pygments
160+
# ipython
161+
# pydata-sphinx-theme
162+
# sphinx
163+
pyjwt==2.6.0
164+
# via pygithub
165+
pynacl==1.5.0
166+
# via pygithub
167+
pyrsistent==0.19.3
168+
# via jsonschema
169+
python-dateutil==2.8.2
170+
# via jupyter-client
171+
pyyaml==6.0
172+
# via
173+
# jupyter-cache
174+
# myst-nb
175+
# myst-parser
176+
# sphinx-external-toc
177+
pyzmq==25.0.2
178+
# via
179+
# ipykernel
180+
# jupyter-client
181+
requests==2.28.2
182+
# via
183+
# pygithub
184+
# sphinx
185+
rocm-docs-core==0.2.0
186+
# via -r .sphinx/requirements.in
187+
six==1.16.0
188+
# via
189+
# asttokens
190+
# python-dateutil
191+
smmap==5.0.0
192+
# via gitdb
193+
snowballstemmer==2.2.0
194+
# via sphinx
195+
soupsieve==2.4
196+
# via beautifulsoup4
197+
sphinx==4.3.1
198+
# via
199+
# breathe
200+
# myst-nb
201+
# myst-parser
202+
# pydata-sphinx-theme
203+
# rocm-docs-core
204+
# sphinx-book-theme
205+
# sphinx-copybutton
206+
# sphinx-design
207+
# sphinx-external-toc
208+
# sphinx-notfound-page
209+
sphinx-book-theme==1.0.0rc2
210+
# via rocm-docs-core
211+
sphinx-copybutton==0.5.1
212+
# via rocm-docs-core
213+
sphinx-design==0.3.0
214+
# via rocm-docs-core
215+
sphinx-external-toc==0.3.1
216+
# via rocm-docs-core
217+
sphinx-notfound-page==0.8.3
218+
# via rocm-docs-core
219+
sphinxcontrib-applehelp==1.0.4
220+
# via sphinx
221+
sphinxcontrib-devhelp==1.0.2
222+
# via sphinx
223+
sphinxcontrib-htmlhelp==2.0.1
224+
# via sphinx
225+
sphinxcontrib-jsmath==1.0.1
226+
# via sphinx
227+
sphinxcontrib-qthelp==1.0.3
228+
# via sphinx
229+
sphinxcontrib-serializinghtml==1.1.5
230+
# via sphinx
231+
sqlalchemy==1.4.47
232+
# via jupyter-cache
233+
stack-data==0.6.2
234+
# via ipython
235+
tabulate==0.9.0
236+
# via jupyter-cache
237+
tornado==6.2
238+
# via
239+
# ipykernel
240+
# jupyter-client
241+
traitlets==5.9.0
242+
# via
243+
# comm
244+
# ipykernel
245+
# ipython
246+
# jupyter-client
247+
# jupyter-core
248+
# matplotlib-inline
249+
# nbclient
250+
# nbformat
251+
typing-extensions==4.5.0
252+
# via
253+
# myst-nb
254+
# myst-parser
255+
# pydata-sphinx-theme
256+
uc-micro-py==1.0.1
257+
# via linkify-it-py
258+
urllib3==1.26.15
259+
# via requests
260+
wcwidth==0.2.6
261+
# via prompt-toolkit
262+
wrapt==1.15.0
263+
# via deprecated
264+
zipp==3.15.0
265+
# via importlib-metadata
266+
267+
# The following packages are considered to be unsafe in a requirements file:
268+
# setuptools

‎amd/hipcc/docs/build.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Building
2+
3+
```bash
4+
mkdir build
5+
cd build
6+
7+
cmake ..
8+
9+
make -j
10+
```
11+
12+
The hipcc and hipconfig executables are created in the current build folder. These executables need to be copied to /opt/rocm/hip/bin folder location. Packaging and installing will be handled in future releases.

‎amd/hipcc/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("HIPCC 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)