Centralize common css & js code in docs (#4844)

This PR will utilize the common css & js code being merged here: rapidsai/docs#286 Authors: - GALI PREM SAGAR (https://github.com/galipremsagar) Approvers: - AJ Schmidt (https://github.com/ajschmidt8) - Dante Gama Dessavre (https://github.com/dantegd) URL: #4844
rapidsai · Aug 4, 2022 · 55d3ef4 · 55d3ef4
1 parent 3b3b891
commit 55d3ef4
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 7 deletions.
diff --git a/conda/environments/builddocs_py37.yml b/conda/environments/builddocs_py37.yml
@@ -20,12 +20,11 @@ dependencies:
 # required for building rapids project docs
 - sphinx
 - sphinx_rtd_theme
+- sphinx-markdown-tables
 - sphinxcontrib-websupport
 - nbsphinx
 - numpydoc
 - ipython
 - recommonmark
 - pandoc=<2.0.0
 - pip
-- pip:
-  - sphinx-markdown-tables
diff --git a/conda/environments/cuml_dev_cuda11.0.yml b/conda/environments/cuml_dev_cuda11.0.yml
@@ -29,14 +29,14 @@ dependencies:
 - faiss-proc=*=cuda
 - umap-learn
 - scikit-learn=0.24
+- sphinx-markdown-tables
 - treelite=2.4.0
 - statsmodels
 - seaborn
 - hdbscan
 - nltk
 - pip
 - pip:
-    - sphinx_markdown_tables
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/dask-glm@main

diff --git a/conda/environments/cuml_dev_cuda11.2.yml b/conda/environments/cuml_dev_cuda11.2.yml
@@ -29,14 +29,14 @@ dependencies:
 - faiss-proc=*=cuda
 - umap-learn
 - scikit-learn=0.24
+- sphinx-markdown-tables
 - treelite=2.4.0
 - statsmodels
 - seaborn
 - hdbscan
 - nltk
 - pip
 - pip:
-    - sphinx_markdown_tables
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/dask-glm@main

diff --git a/conda/environments/cuml_dev_cuda11.4.yml b/conda/environments/cuml_dev_cuda11.4.yml
@@ -29,14 +29,14 @@ dependencies:
 - faiss-proc=*=cuda
 - umap-learn
 - scikit-learn=0.24
+- sphinx-markdown-tables
 - treelite=2.4.0
 - statsmodels
 - seaborn
 - hdbscan
 - nltk
 - pip
 - pip:
-    - sphinx_markdown_tables
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/dask-glm.git@main

diff --git a/conda/environments/cuml_dev_cuda11.5.yml b/conda/environments/cuml_dev_cuda11.5.yml
@@ -29,14 +29,14 @@ dependencies:
 - faiss-proc=*=cuda
 - umap-learn
 - scikit-learn=0.24
+- sphinx-markdown-tables
 - treelite=2.4.0
 - statsmodels
 - seaborn
 - hdbscan
 - nltk
 - pip
 - pip:
-    - sphinx_markdown_tables
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/[email protected]
     - git+https://github.com/dask/dask-glm@main

diff --git a/cpp/Doxyfile.in b/cpp/Doxyfile.in
@@ -1082,7 +1082,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            =
+HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard

diff --git a/cpp/header.html b/cpp/header.html
@@ -0,0 +1,62 @@
+<!-- HTML header for doxygen 1.8.20-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+$treeview
+$search
+$mathjax
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+
+<!-- RAPIDS CUSTOM JS & CSS: START, Please add these two lines back after every version upgrade -->
+<script defer src="https://docs.rapids.ai/assets/js/custom.js"></script>
+<link rel="stylesheet" href="https://docs.rapids.ai/assets/css/custom.css">
+<!-- RAPIDS CUSTOM JS & CSS: END -->
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <!--BEGIN PROJECT_LOGO-->
+  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
+  <!--END PROJECT_LOGO-->
+  <!--BEGIN PROJECT_NAME-->
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">$projectname
+   <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
+   </div>
+   <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+  </td>
+  <!--END PROJECT_NAME-->
+  <!--BEGIN !PROJECT_NAME-->
+   <!--BEGIN PROJECT_BRIEF-->
+    <td style="padding-left: 0.5em;">
+    <div id="projectbrief">$projectbrief</div>
+    </td>
+   <!--END PROJECT_BRIEF-->
+  <!--END !PROJECT_NAME-->
+  <!--BEGIN DISABLE_INDEX-->
+   <!--BEGIN SEARCHENGINE-->
+   <td>$searchbox</td>
+   <!--END SEARCHENGINE-->
+  <!--END DISABLE_INDEX-->
+ </tr>
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->