Skip to content

Commit 709bf20

Browse files
author
Diptorup Deb
committed
Reorganize rst files into a sub-folder.
1 parent 6babc15 commit 709bf20

14 files changed

+26
-31
lines changed

docs/conf.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ extensions = [
3333
"sphinx.ext.githubpages",
3434
"sphinx.ext.autodoc",
3535
"sphinx.ext.napoleon",
36+
"sphinx.ext.todo",
3637
]
3738

3839
use_doxyrest = "@DPCTL_ENABLE_DOXYREST@"
@@ -61,7 +62,7 @@ source_suffix = ".rst"
6162
# This pattern also affects html_static_path and html_extra_path.
6263
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
6364

64-
highlight_language = "C"
65+
highlight_language = "Python"
6566

6667
# The name of the Pygments (syntax highlighting) style to use.
6768
pygments_style = "sphinx"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/docfiles/intro.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Welcome to Data-parallel Control (dpctl)'s documentation!
2+
=========================================================
3+
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
6+
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.
8+
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
:caption: Contents:
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`
File renamed without changes.

docs/index_doxyrest.rst.in

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,11 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55

6-
Welcome to Data-parallel Control (dpctl)'s documentation!
7-
=========================================================
8-
9-
.. toctree::
10-
:maxdepth: 2
11-
:caption: Contents:
12-
13-
14-
Indices and tables
15-
==================
16-
17-
* :ref:`genindex`
18-
* :ref:`modindex`
19-
* :ref:`search`
6+
.. include:: ./docfiles/intro.rst
207

218
.. toctree::
229
:maxdepth: 3
2310
:caption: Contents:
2411

25-
toc_pyapi
12+
docfiles/toc_pyapi
2613
@DOXYREST_OUTPUT_DIR_NAME@/index

docs/index_no_doxyrest.rst.in

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,10 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55

6-
Welcome to Data-parallel Control (dpctl)'s documentation!
7-
=========================================================
8-
9-
.. toctree::
10-
:maxdepth: 2
11-
:caption: Contents:
12-
13-
14-
Indices and tables
15-
==================
16-
17-
* :ref:`genindex`
18-
* :ref:`modindex`
19-
* :ref:`search`
6+
.. include:: ./docfiles/intro.rst
207

218
.. toctree::
229
:maxdepth: 3
2310
:caption: Contents:
2411

25-
toc_pyapi
12+
docfiles/toc_pyapi

0 commit comments

Comments
 (0)