Skip to content

Commit ae878e1

Browse files
author
Diptorup Deb
committed
Move all rst files into the new docfiles sub-directory
 - Changes name of all files to use dpctl instead of dpCtl. - Remove toc_pyapi.rst
1 parent 08e3336 commit ae878e1

File tree

9 files changed

+59
-45
lines changed

9 files changed

+59
-45
lines changed

‎docs/docfiles/boilerplate.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
About
2+
=====
3+
4+
dpctl is developed by Intel and is part of the `Intel Distribution for
5+
Python <https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html>`_.
6+
7+
Contributing
8+
============
9+
10+
Refer the `contributing guide <https://github.com/IntelPython/dpctl/blob/master/CONTRIBUTING.md>`_
11+
for information on coding style and standards used in dpctl.
12+
13+
License
14+
=======
15+
16+
dpctl is Licensed under Apache License 2.0 that can be found in
17+
`LICENSE <https://github.com/IntelPython/dpctl/blob/master/LICENSE>`_.
18+
All usage and contributions to the project are subject to the terms and
19+
conditions of this license.

docs/dpCtl.dptensor_api.rst renamed to docs/docfiles/dpctl.dptensor_api.rst

File renamed without changes.

docs/dpCtl.memory_api.rst renamed to docs/docfiles/dpctl.memory_api.rst

File renamed without changes.

docs/dpCtl.program_api.rst renamed to docs/docfiles/dpctl.program_api.rst

File renamed without changes.

docs/dpCtl_api.rst renamed to docs/docfiles/dpctl_pyapi.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
.. _dpCtl_api:
1+
.. _dpctl_pyapi:
22

33
################
44
dpctl Python API
55
################
66

77
.. automodule:: dpctl
88

9+
Sub-modules
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
15+
dpctl.dptensor_api
16+
dpctl.memory_api
17+
dpctl.program_api
18+
919
Classes
1020
-------
1121

@@ -64,4 +74,4 @@ Functions
6474
.. autofunction:: get_current_queue
6575
.. autofunction:: get_num_activated_queues
6676
.. autofunction:: is_in_device_context
67-
.. autofunction:: set_global_queue
77+
.. autofunction:: set_global_queue

‎docs/docfiles/intro.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome to Data-parallel Control (dpctl)'s documentation!
2+
=========================================================
3+
4+
The data-parallel control (dpctl) library provides C and Python bindings for
5+
`SYCL 2020 <https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html>`_.
6+
The SYCL 2020 features supported by dpctl are limited to those included by
7+
Intel's DPCPP compiler and specifically cover the SYCL runtime classes described
8+
in `Section 4.6 <https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes>`_
9+
of the SYCL 2020 specification. Apart from the bindings for these runtime
10+
classes, dpctl includes bindings for SYCL USM memory allocators and
11+
deallocators. Dpctl's Python API provides classes that implement
12+
`Python buffer protocol <https://docs.python.org/3/c-api/buffer.html>`_
13+
using SYCL USM memory; making it possible to create Python objects that are
14+
backed by SYCL USM memory.
15+
16+
Dpctl also supports the DPCPP ``ONEAPI::filter_selector`` extension and has
17+
experimental support for SYCL's ``kernel`` and ``program`` classes.

‎docs/index_doxyrest.rst.in‎

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,10 @@
1-
Welcome to Data-parallel Control (dpctl)'s documentation!
2-
=========================================================
1+
.. include:: ./docfiles/intro.rst
32

43
.. toctree::
5-
:maxdepth: 2
6-
:caption: Contents:
4+
:maxdepth: 1
5+
:caption: API Documentation
76

8-
9-
Indices and tables
10-
==================
11-
12-
* :ref:`genindex`
13-
* :ref:`modindex`
14-
* :ref:`search`
15-
16-
.. toctree::
17-
:maxdepth: 3
18-
:caption: Contents:
19-
20-
toc_pyapi
7+
docfiles/dpctl_pyapi
218
@DOXYREST_OUTPUT_DIR_NAME@/index
9+
10+
.. include:: ./docfiles/boilerplate.rst

‎docs/index_no_doxyrest.rst.in‎

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,9 @@
1-
Welcome to Data-parallel Control (dpctl)'s documentation!
2-
=========================================================
1+
.. include:: ./docfiles/intro.rst
32

43
.. toctree::
5-
:maxdepth: 2
6-
:caption: Contents:
4+
:maxdepth: 1
5+
:caption: API Documentation
76

7+
docfiles/dpctl_pyapi
88

9-
Indices and tables
10-
==================
11-
12-
* :ref:`genindex`
13-
* :ref:`modindex`
14-
* :ref:`search`
15-
16-
.. toctree::
17-
:maxdepth: 3
18-
:caption: Contents:
19-
20-
toc_pyapi
9+
.. include:: ./docfiles/boilerplate.rst

‎docs/toc_pyapi.rst‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)