Skip to content

Commit 946a75d

Browse files
evetssosamjwu
andauthored
merge doc changes for 5.6
* Add dependabot config and pin rocm-docs-core * fix documentation use correct ref for doxygenenum directive * Update dependabot config * Update documentation requirements Update documentation dependencies via requirements file Co-authored-by: Sam Wu <[email protected]>
1 parent 4757a02 commit 946a75d

File tree

5 files changed

+47
-161
lines changed

5 files changed

+47
-161
lines changed

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
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"

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,5 @@ _images/
4747
_static/
4848
_templates/
4949
_toc.yml
50-
docBin/
50+
docBin/
51+
_doxygen/

docs/.sphinx/requirements.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
1+
rocm-docs-core==0.10.3

docs/.sphinx/requirements.txt

Lines changed: 27 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -8,95 +8,50 @@ accessible-pygments==0.0.3
88
# via pydata-sphinx-theme
99
alabaster==0.7.13
1010
# via sphinx
11-
asttokens==2.2.1
12-
# via stack-data
13-
attrs==22.2.0
14-
# via
15-
# jsonschema
16-
# jupyter-cache
1711
babel==2.12.1
1812
# via
1913
# pydata-sphinx-theme
2014
# sphinx
21-
backcall==0.2.0
22-
# via ipython
2315
beautifulsoup4==4.11.2
2416
# via pydata-sphinx-theme
2517
breathe==4.34.0
2618
# via rocm-docs-core
2719
certifi==2022.12.7
2820
# via requests
2921
cffi==1.15.1
30-
# via pynacl
22+
# via
23+
# cryptography
24+
# pynacl
3125
charset-normalizer==3.1.0
3226
# via requests
3327
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.6
40-
# via ipykernel
41-
decorator==5.1.1
42-
# via ipython
28+
# via sphinx-external-toc
29+
cryptography==40.0.2
30+
# via pyjwt
4331
deprecated==1.2.13
4432
# via pygithub
45-
docutils==0.16
33+
docutils==0.19
4634
# via
4735
# breathe
4836
# myst-parser
4937
# pydata-sphinx-theme
50-
# rocm-docs-core
5138
# sphinx
52-
executing==1.2.0
53-
# via stack-data
54-
fastjsonschema==2.16.3
55-
# via nbformat
5639
gitdb==4.0.10
5740
# via gitpython
5841
gitpython==3.1.31
5942
# via rocm-docs-core
60-
greenlet==2.0.2
61-
# via sqlalchemy
6243
idna==3.4
6344
# via requests
6445
imagesize==1.4.1
6546
# via sphinx
6647
importlib-metadata==6.0.0
67-
# via
68-
# jupyter-cache
69-
# jupyter-client
70-
# myst-nb
71-
importlib-resources==5.10.4
72-
# via
73-
# jsonschema
74-
# rocm-docs-core
75-
ipykernel==6.21.3
76-
# via myst-nb
77-
ipython==8.11.0
78-
# via
79-
# ipykernel
80-
# myst-nb
81-
jedi==0.18.2
82-
# via ipython
48+
# via sphinx
49+
importlib-resources==5.12.0
50+
# via rocm-docs-core
8351
jinja2==3.1.2
8452
# via
8553
# myst-parser
8654
# sphinx
87-
jsonschema==4.17.3
88-
# via nbformat
89-
jupyter-cache==0.5.0
90-
# via myst-nb
91-
jupyter-client==8.0.3
92-
# via
93-
# ipykernel
94-
# nbclient
95-
jupyter-core==5.2.0
96-
# via
97-
# ipykernel
98-
# jupyter-client
99-
# nbformat
10055
linkify-it-py==1.0.3
10156
# via myst-parser
10257
markdown-it-py==2.2.0
@@ -105,123 +60,72 @@ markdown-it-py==2.2.0
10560
# myst-parser
10661
markupsafe==2.1.2
10762
# via jinja2
108-
matplotlib-inline==0.1.6
109-
# via
110-
# ipykernel
111-
# ipython
11263
mdit-py-plugins==0.3.5
11364
# via myst-parser
11465
mdurl==0.1.2
11566
# via markdown-it-py
116-
myst-nb==0.17.1
67+
myst-parser[linkify]==1.0.0
11768
# via rocm-docs-core
118-
myst-parser[linkify]==0.18.1
119-
# via
120-
# myst-nb
121-
# rocm-docs-core
122-
nbclient==0.5.13
123-
# via
124-
# jupyter-cache
125-
# myst-nb
126-
nbformat==5.7.3
127-
# via
128-
# jupyter-cache
129-
# myst-nb
130-
# nbclient
131-
nest-asyncio==1.5.6
132-
# via
133-
# ipykernel
134-
# nbclient
13569
packaging==23.0
13670
# via
137-
# ipykernel
13871
# pydata-sphinx-theme
13972
# sphinx
140-
parso==0.8.3
141-
# via jedi
142-
pexpect==4.8.0
143-
# via ipython
144-
pickleshare==0.7.5
145-
# via ipython
146-
pkgutil-resolve-name==1.3.10
147-
# via jsonschema
148-
platformdirs==3.1.0
149-
# via jupyter-core
150-
prompt-toolkit==3.0.38
151-
# via ipython
152-
psutil==5.9.4
153-
# via ipykernel
154-
ptyprocess==0.7.0
155-
# via pexpect
156-
pure-eval==0.2.2
157-
# via stack-data
15873
pycparser==2.21
15974
# via cffi
160-
pydata-sphinx-theme==0.13.1
161-
# via sphinx-book-theme
162-
pygithub==1.57
75+
pydata-sphinx-theme==0.13.3
76+
# via
77+
# rocm-docs-core
78+
# sphinx-book-theme
79+
pygithub==1.58.1
16380
# via rocm-docs-core
16481
pygments==2.14.0
16582
# via
16683
# accessible-pygments
167-
# ipython
16884
# pydata-sphinx-theme
16985
# sphinx
170-
pyjwt==2.6.0
86+
pyjwt[crypto]==2.6.0
17187
# via pygithub
17288
pynacl==1.5.0
17389
# via pygithub
174-
pyrsistent==0.19.3
175-
# via jsonschema
176-
python-dateutil==2.8.2
177-
# via jupyter-client
178-
pytz==2022.7.1
90+
pytz==2023.3
17991
# via babel
18092
pyyaml==6.0
18193
# via
182-
# jupyter-cache
183-
# myst-nb
18494
# myst-parser
18595
# sphinx-external-toc
186-
pyzmq==25.0.0
187-
# via
188-
# ipykernel
189-
# jupyter-client
19096
requests==2.28.2
19197
# via
19298
# pygithub
19399
# sphinx
194-
rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
100+
rocm-docs-core==0.10.3
195101
# via -r requirements.in
196-
six==1.16.0
197-
# via
198-
# asttokens
199-
# python-dateutil
200102
smmap==5.0.0
201103
# via gitdb
202104
snowballstemmer==2.2.0
203105
# via sphinx
204106
soupsieve==2.4
205107
# via beautifulsoup4
206-
sphinx==4.3.1
108+
sphinx==5.3.0
207109
# via
208110
# breathe
209-
# myst-nb
210111
# myst-parser
211112
# pydata-sphinx-theme
212113
# rocm-docs-core
213114
# sphinx-book-theme
214115
# sphinx-copybutton
215116
# sphinx-design
216117
# sphinx-external-toc
217-
sphinx-book-theme==1.0.0rc2
118+
# sphinx-notfound-page
119+
sphinx-book-theme==1.0.1
218120
# via rocm-docs-core
219121
sphinx-copybutton==0.5.1
220122
# via rocm-docs-core
221-
sphinx-design==0.3.0
123+
sphinx-design==0.4.1
222124
# via rocm-docs-core
223125
sphinx-external-toc==0.3.1
224126
# via rocm-docs-core
127+
sphinx-notfound-page==0.8.3
128+
# via rocm-docs-core
225129
sphinxcontrib-applehelp==1.0.4
226130
# via sphinx
227131
sphinxcontrib-devhelp==1.0.2
@@ -234,42 +138,15 @@ sphinxcontrib-qthelp==1.0.3
234138
# via sphinx
235139
sphinxcontrib-serializinghtml==1.1.5
236140
# via sphinx
237-
sqlalchemy==1.4.46
238-
# via jupyter-cache
239-
stack-data==0.6.2
240-
# via ipython
241-
tabulate==0.9.0
242-
# via jupyter-cache
243-
tornado==6.2
244-
# via
245-
# ipykernel
246-
# jupyter-client
247-
traitlets==5.9.0
248-
# via
249-
# comm
250-
# ipykernel
251-
# ipython
252-
# jupyter-client
253-
# jupyter-core
254-
# matplotlib-inline
255-
# nbclient
256-
# nbformat
257141
typing-extensions==4.5.0
258-
# via
259-
# myst-nb
260-
# myst-parser
142+
# via pydata-sphinx-theme
261143
uc-micro-py==1.0.1
262144
# via linkify-it-py
263-
urllib3==1.26.14
145+
urllib3==1.26.15
264146
# via requests
265-
wcwidth==0.2.6
266-
# via prompt-toolkit
267147
wrapt==1.15.0
268148
# via deprecated
269149
zipp==3.15.0
270150
# via
271151
# importlib-metadata
272152
# importlib-resources
273-
274-
# The following packages are considered to be unsafe in a requirements file:
275-
# setuptools

docs/api.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,18 +100,14 @@ Enumerations
100100

101101
This section provides all the enumerations used.
102102

103-
.. doxygenenum:: rocfft_status_e
103+
.. doxygenenum:: rocfft_status
104104

105-
.. doxygenenum:: rocfft_transform_type_e
105+
.. doxygenenum:: rocfft_transform_type
106106

107-
.. doxygenenum:: rocfft_precision_e
107+
.. doxygenenum:: rocfft_precision
108108

109-
.. doxygenenum:: rocfft_result_placement_e
109+
.. doxygenenum:: rocfft_result_placement
110110

111-
.. doxygenenum:: rocfft_array_type_e
111+
.. doxygenenum:: rocfft_array_type
112112

113113
.. comment doxygenenum:: rocfft_execution_mode
114-
115-
116-
117-

0 commit comments

Comments
 (0)