Skip to content

Commit bfb5c07

Browse files
author
Diptorup Deb
committed
Add stubs...
1 parent 96b760a commit bfb5c07

File tree

5 files changed

+34
-19
lines changed

5 files changed

+34
-19
lines changed

docs/docfiles/intro.rst

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
Welcome to Data-parallel Control (dpctl)'s documentation!
22
=========================================================
33

4-
Data-parallel control (``dpctl``) is a library that exposes SYCL and DPCPP to
5-
languages other than C++. Currently, ``dpctl`` provides SYCL bindings for C and
4+
Data-parallel control (dpctl) is a library that exposes SYCL and DPCPP to
5+
languages other than C++. Currently, dpctl provides SYCL bindings for C and
66
Python making it possible to access SYCL runtime objects and methods from these
7-
languages. The SYCL functionality covered by ``dpctl`` includes the core SYCL runtime classes described in Section 4.6 of the `SYCL 2020 spec <https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes>`_ and USM memory management. ``Dpctl`` also has experimental support for DPCPP ``kernel`` and ``program`` classes.
7+
languages. The SYCL functionality covered by dpctl includes the core SYCL
8+
runtime classes described in Section 4.6 of the
9+
`SYCL 2020 spec <https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes>`_
10+
and USM memory management. dpctl also has experimental support for SYCL's
11+
``kernel`` and ``program`` classes.
812

13+
Core Features
14+
-------------
915

10-
.. toctree::
11-
:maxdepth: 2
12-
:caption: Contents:
16+
.. todo::
1317

18+
Coming soon.
1419

15-
Indices and tables
16-
==================
20+
User Guidies
21+
------------
22+
23+
.. todo::
24+
25+
Device Management.
26+
27+
.. todo::
28+
29+
USM Memory Management
1730

18-
* :ref:`genindex`
19-
* :ref:`modindex`
20-
* :ref:`search`

docs/docfiles/toc_pyapi.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
Python API
2-
==========
1+
dpctl Python API
2+
================
33

44
.. toctree::
5-
:maxdepth: 1
5+
:hidden:
66

77
dpctl - SYCL runtime wrapper classes and queue manager <dpctl_pyapi>
88
dpctl.dptensor - Data-parallel tensor containers <dpctl.dptensor_api>
99
dpctl.memory - USM memory manager <dpctl.memory_api>
1010
dpctl.program - Program manager <dpctl.program_api>
11+

docs/doxyrest-config.lua.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ FOOTNOTE_MEMBER_PREFIX = nil
146146
--! formatting of module item declarations.
147147
--!
148148

149-
LANGUAGE = C
149+
LANGUAGE = CPP
150150

151151
--!
152152
--! Convert ``\verbatim`` sections in doxy-comments to ``.. code-block::``

docs/index_doxyrest.rst.in

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
.. include:: ./docfiles/intro.rst
77

88
.. toctree::
9-
:maxdepth: 3
10-
:caption: Contents:
9+
:maxdepth: 1
10+
:caption: API Documentation
1111

1212
docfiles/toc_pyapi
1313
@DOXYREST_OUTPUT_DIR_NAME@/index
14+
15+
.. include:: ./docfiles/boilerplate.rst

docs/index_no_doxyrest.rst.in

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
.. include:: ./docfiles/intro.rst
77

88
.. toctree::
9-
:maxdepth: 3
10-
:caption: Contents:
9+
:maxdepth: 1
10+
:caption: API Documentation
1111

1212
docfiles/toc_pyapi
13+
14+
.. include:: ./docfiles/boilerplate.rst

0 commit comments

Comments
 (0)