Added code to add extensions if using DoxyRest

Author: oleksandr-pavlyk

docs/CMakeLists.txt

@@ -98,6 +98,9 @@ function(_setup_sphinx)
     set(SPHINX_OUTPUT_DIR ${DOC_OUTPUT_DIR}/docs)
     set(SPHINX_INDEX_FILE ${SPHINX_OUTPUT_DIR}/index.html)
 
+    set(SPHINX_CONF_IN ${SPHINX_SOURCE}/conf.py.in)
+    set(SPHINX_CONF_OUT ${SPHINX_SOURCE}/conf.py)
+
     if(DPCTL_ENABLE_DOXYREST)
         set(DEPEND_ON_DOXYREST "Doxyrest")
     endif()
@@ -120,7 +123,7 @@ function(_setup_sphinx)
             ${SPHINX_INDEX_FILE}
     )
     # Create a conf.py by replacing variables inside @@ with the current values
-    # configure_file(${SPHINX_CONF_IN} ${SPHINX_CONF_OUT} @ONLY)
+    configure_file(${SPHINX_CONF_IN} ${SPHINX_CONF_OUT} @ONLY)
 endfunction()
 
 function(_set_current_release)

docs/doc_sources/conf.py renamed to docs/doc_sources/conf.py.in

@@ -37,10 +37,37 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinxcontrib.programoutput",
-    # "sphinxcontrib.googleanalytics",
+    "sphinxcontrib.googleanalytics",
     "sphinx_design",
 ]
 
+googleanalytics_id = 'G-7TCKS5BHYE'
+googleanalytics_enabled = True
+
+todo_include_todos = True
+use_doxyrest = "@DPCTL_ENABLE_DOXYREST@"
+
+if use_doxyrest == "ON":
+    # Specify the path to Doxyrest extensions for Sphinx:
+    import os
+    import sys
+
+    sys.path.insert(
+        1,
+        os.path.abspath("@DOXYREST_SPHINX_DIR@"),
+    )
+    extensions += ["doxyrest", "cpplexer"]
+    # A workaround to fix issues leftover in the doxyrest generated
+    # rst files.
+    import fileinput
+
+    with fileinput.FileInput(
+        "@DOXYREST_OUTPUT_DIR@/global.rst", inplace=True
+    ) as file:
+        for line in file:
+            print(line.replace("typedefDPCTL_C_EXTERN_C_BEGIN", ""), end="")
+
+
 templates_path = ["_templates"]
 exclude_patterns = []
 
@@ -82,3 +109,44 @@
     "numba_dpex": ("https://intelpython.github.io/numba-dpex/latest/", None),
     "cython": ("https://docs.cython.org/en/latest/", None),
 }
+
+# When the cmake DPCTL_USE_MULTIVERSION_TEMPLATE flag is set we generate
+# links in the sidebar to the documentation for older versions of dpctl.
+# Note that this option does not actually generate the documentation for
+# older versions, it only adds links in the sidebar to earlier versions of
+# the documentation. All earlier versions of the documentation should be
+# generated and pushed to the gh-pages branch manually, after which the
+# doc_versions.txt should be updated.
+
+generate_multiversion = "@DPCTL_USE_MULTIVERSION_TEMPLATE@"
+
+if generate_multiversion == "ON":
+    try:
+        html_context
+    except NameError:
+        html_context = dict()
+    html_context["display_lower_left"] = True
+    templates_path = ["_templates"]
+    html_context["current_version"] = version
+    html_context["version"] = version
+
+    # POPULATE LINKS TO OTHER VERSIONS
+    html_context["versions"] = list()
+
+    # Populate the list of documented versions from the doc_versions.tx
+    versions = []
+    with open("doc_versions.txt", "r") as doc_versions:
+        while True:
+            version = doc_versions.readline().strip()
+            if not version:
+                break
+            elif len(version):
+                versions.append(version)
+
+    # FIXME: Remove this hard coding
+    DOC_SITE_NAME = "https://intelpython.github.io/dpctl/"
+
+    for version in versions:
+        html_context["versions"].append(
+            (version, DOC_SITE_NAME + version + "/index.html")
+        )