aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentina Kats <valentina.kats@intel.com>2021-02-16 17:46:20 +0300
committerGitHub <noreply@github.com>2021-02-16 17:46:20 +0300
commit46b0ca7af68b62e505c58b038e101aa89906c16f (patch)
tree180f89a29ed70aba86e7417eb6d51ac66d8b854b
parentRefactor generated names of kernels (#113) (diff)
downloadllvm-project-46b0ca7af68b62e505c58b038e101aa89906c16f.tar.gz
llvm-project-46b0ca7af68b62e505c58b038e101aa89906c16f.tar.bz2
llvm-project-46b0ca7af68b62e505c58b038e101aa89906c16f.zip
Update theme and index files (#124)
-rw-r--r--documentation/library_guide/conf.py16
-rw-r--r--documentation/library_guide/extension_api.rst6
-rw-r--r--documentation/library_guide/index.rst1
-rw-r--r--documentation/library_guide/pstl/index.rst7
-rw-r--r--documentation/library_guide/pstl_main.rst7
-rw-r--r--documentation/library_guide/requirements.txt2
6 files changed, 19 insertions, 20 deletions
diff --git a/documentation/library_guide/conf.py b/documentation/library_guide/conf.py
index 15a40d5ff551..bf60a1584bcf 100644
--- a/documentation/library_guide/conf.py
+++ b/documentation/library_guide/conf.py
@@ -115,21 +115,21 @@ html_show_sourcelink = False
import sys
import os
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get('READTHEDOCS', None) == 'False'
import sphinx_rtd_theme
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-if on_rtd:
- using_rtd_theme = True
+html_theme = 'sphinx_book_theme'
+#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#if on_rtd:
+# using_rtd_theme = True
# Theme options
html_theme_options = {
# 'typekit_id': 'hiw1hhg',
# 'analytics_id': '',
# 'sticky_navigation': True, # Set to False to disable the sticky nav while scrolling.
- 'logo_only': False, # if we have a html_logo below, this shows /only/ the logo with no title text
- 'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
+ #'logo_only': False, # if we have a html_logo below, this shows /only/ the logo with no title text
+ #'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
# 'display_version': True, # Display the docs version
- 'navigation_depth': 4 # Depth of the headers shown in the navigation bar
+ #'navigation_depth': 4 # Depth of the headers shown in the navigation bar
}
diff --git a/documentation/library_guide/extension_api.rst b/documentation/library_guide/extension_api.rst
index b2877143a006..5fbfbf09231c 100644
--- a/documentation/library_guide/extension_api.rst
+++ b/documentation/library_guide/extension_api.rst
@@ -235,13 +235,13 @@ The definitions of the function objects provided in the Extension API are availa
``oneapi/dpl/functional`` header. All function objects are implemented in the ``oneapi::dpl`` namespace.
- identity: A C++11 implementation of the C++20 ``std::identity`` function object type, where the operator() returns the
-argument unchanged.
+ argument unchanged.
- minimum: A function object type where the operator() applies ``std::less`` to its arguments, then returns the
-lesser argument unchanged.
+ lesser argument unchanged.
- maximum: A function object type where the operator() applies ``std::greater`` to its arguments, then returns the
-greater argument unchanged.
+ greater argument unchanged.
Range-based API
--------------------------
diff --git a/documentation/library_guide/index.rst b/documentation/library_guide/index.rst
index ca78e756a624..9387b3ae80a9 100644
--- a/documentation/library_guide/index.rst
+++ b/documentation/library_guide/index.rst
@@ -15,7 +15,6 @@ oneDPL consists of the following components:
before_you_begin
pstl_main
- pstl/index
extension_api
tested_standard_cpp_api
random
diff --git a/documentation/library_guide/pstl/index.rst b/documentation/library_guide/pstl/index.rst
deleted file mode 100644
index 797b95adfa28..000000000000
--- a/documentation/library_guide/pstl/index.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. _pstl:
-
-.. toctree::
- :maxdepth: 1
-
- dpcpp_policies_usage
- macros \ No newline at end of file
diff --git a/documentation/library_guide/pstl_main.rst b/documentation/library_guide/pstl_main.rst
index 8b5a70a24830..33856a44d504 100644
--- a/documentation/library_guide/pstl_main.rst
+++ b/documentation/library_guide/pstl_main.rst
@@ -56,3 +56,10 @@ To use Parallel STL with the DPC++ execution policies, you must have the followi
* C++ compiler with support for SYCL 2020
+.. _pstl:
+
+.. toctree::
+ :maxdepth: 1
+
+ pstl/dpcpp_policies_usage
+ pstl/macros \ No newline at end of file
diff --git a/documentation/library_guide/requirements.txt b/documentation/library_guide/requirements.txt
index 464f501bdd42..1f5f2ac59b3b 100644
--- a/documentation/library_guide/requirements.txt
+++ b/documentation/library_guide/requirements.txt
@@ -1,6 +1,6 @@
breathe==4.9.1
sphinx==3.2.1
docutils==0.14
-sphinx_rtd_theme
+sphinx_book_theme
sphinx-intl==2.0.0
sphinx-tabs \ No newline at end of file