Merge pull request #2257 from RCarter-IDM/pydata

from rtd to pydata sphinx theme

docs/_templates/footer_end.html

@@ -0,0 +1,2 @@
+<p><a href="https://www.gatesfoundation.org/Privacy-and-Cookies-Notice">Privacy and Cookies Notice</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+<a href="https://www.gatesfoundation.org/Terms-of-Use">Terms of Use</a></p>

docs/_templates/footer_start.html

@@ -0,0 +1,3 @@
+<p>idmtools is licensed under the <a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode">Creative Commons
+    Attribution-ShareAlike 4.0 International License</a>.</p>
+<p>Send documentation feedback to <a href="mailto:idmsupport@gatesfoundation.org" target="_top">idmsupport@gatesfoundation.org</a>.</p>

docs/_templates/navbar-side.html

@@ -0,0 +1,12 @@
+{# Displays links to the top-level TOCtree elements, in the header navbar. #}
+<nav class="navbar-nav">
+  <p class="sidebar-header-items__title"
+     role="heading"
+     aria-level="1"
+     aria-label="{{ _('') }}">
+    {{ _("") }}
+  </p>
+  <ul class="bd-navbar-elements navbar-nav">
+    {{ generate_header_nav_html(n_links_before_dropdown=20, dropdown_text=theme_header_dropdown_text) }}
+  </ul>
+</nav>

docs/conf.py

@@ -20,7 +20,7 @@
 import os
 import subprocess
 import sys
-import sphinx_rtd_theme
+#import sphinx_rtd_theme
 from datetime import datetime
 
 if sys.platform in ["linux", "darwin"]:
@@ -191,17 +191,48 @@
 # The theme to use for HTML and HTML Help pages.  See the docs for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'pydata_sphinx_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # docs.
 # #
-# html_theme_options = {
-# }
+html_theme_options = {
+    "collapse_navigation": False,
+    "navigation_depth": 3,
+    "show_prev_next": True,
+    "icon_links": [
+        {"name": "IDM docs", "url": "https://docs.idmod.org", "icon": "fas fa-home"},
+        {
+            "name": "GitHub",
+            "url": "https://github.com/institutefordiseasemodeling/idmtools",
+            "icon": "fab fa-github-square",
+        },
+    ],
+    "navbar_end": ["theme-switcher", "navbar-icon-links"],
+    "secondary_sidebar_items": ["navbar-side"],
+    "header_links_before_dropdown": 5,
+    "footer_start": ["copyright", "footer_start"],
+    "footer_end": ["theme-version", "footer_end"],
+}
+html_sidebars = {
+    "**": ["sidebar-nav-bs", "page-toc"],
+}
+html_logo = "images/idm-logo-transparent.png"
+html_favicon = "images/favicon.ico"
+html_static_path = ['_static']
+html_baseurl = "https://docs.idmod.org/projects/idmtools/en/latest"
+html_context = {
+    'rtd_url': 'https://docs.idmod.org/projects/idmtools/en/latest',
+    "versions_dropdown": {
+        "latest": "devel (latest)",
+        "stable": "current (stable)",
+    },
+    "default_mode": "light",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> docs" by default.
@@ -215,7 +246,7 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-html_logo = "images/IDM_white.png"
+#html_logo = "images/IDM_white.png"
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -231,7 +262,7 @@
 
 html_css_files = ['theme_overrides.css']
 
-html_js_files = ['show_block_by_os.js'] 
+#html_js_files = ['show_block_by_os.js']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

docs/requirements.txt

@@ -1,7 +1,7 @@
 pygit2>=1.4.0
 sphinxext-rediraffe
 sphinx~=6.2.1
-sphinx-rtd-theme~=1.2.2
+pydata-sphinx-theme
 sphinxcontrib-napoleon~=0.7
 plantweb~=1.2.1
 sphinxcontrib-programoutput~=0.17