In progress work for changing theme over to pydata

docs/conf.py

@@ -16,7 +16,7 @@
 
 BLOG_TITLE = title = html_title = "Docs"
 BLOG_AUTHOR = author = "Quansight"
-html_theme = "sphinx_material"
+html_theme = "pydata_sphinx_theme"
 
 # The master toctree document.
 master_doc = "index"
@@ -63,54 +63,56 @@
 
 # Material theme options (see theme.conf for more information)
 
-html_theme_options = {
-    "nav_title": "Welcome to QHub's documentation!",
-    # 'google_analytics_account': 'UA-XXXXX',     
-    # Set you GA account ID to enable tracking
-    # Specify a base_url used to generate sitemap.xml. If not, no sitemap will be built.
-    "base_url": "https://qhub.dev/",
-    # Set the color and the accent color
-    "theme_color": THEME_COLOR,
-    "color_primary": THEME_COLOR,
-    "color_accent": "light-yellow",
-    # Set the repo location to get a badge with stats
-    "repo_url": "https://github.com/Quansight/qhub",
-    "repo_name": "QHub",
-    # Visible levels of the global TOC; -1 means unlimited
-    "globaltoc_depth": 2,
-    # If False, expand all TOC entries
-    "globaltoc_collapse": True,
-    # If True, show hidden TOC entries
-    "globaltoc_includehidden": False,
-
-    "nav_links": [
-            {
-            "href": "https://www.quansight.com/jupyter-consulting",
-            "title": "Quansight",
-            "internal": False,
-
-        },
-            {
-            "href": "https://hpc.qhub.dev/",
-            "title": "QHub HPC",
-            "internal": False,
-
-        },
-            {
-                "href": "https://pypi.org/project/qhub/",
-                "title": "PyPI",
-                "internal": False,
-
-        },
-        ],
-
-    }
-
-html_sidebars = {
-    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
-    }
-
-# Exclude build directory and Jupyter backup files:
+# html_theme_options = {
+#     "nav_title": "Welcome to QHub's documentation!",
+#     # 'google_analytics_account': 'UA-XXXXX',     
+#     # Set you GA account ID to enable tracking
+#     # Specify a base_url used to generate sitemap.xml. If not, no sitemap will be built.
+#     "base_url": "https://qhub.dev/",
+#     # Set the color and the accent color
+#     "theme_color": THEME_COLOR,
+#     "color_primary": THEME_COLOR,
+#     "color_accent": "light-yellow",
+#     # Set the repo location to get a badge with stats
+#     "repo_url": "https://github.com/Quansight/qhub",
+#     "repo_name": "QHub",
+#     # Visible levels of the global TOC; -1 means unlimited
+#     "globaltoc_depth": 2,
+#     # If False, expand all TOC entries
+#     "globaltoc_collapse": True,
+#     # If True, show hidden TOC entries
+#     "globaltoc_includehidden": False,
+
+#     "nav_links": [
+#             {
+#             "href": "https://www.quansight.com/jupyter-consulting",
+#             "title": "Quansight",
+#             "internal": False,
+
+#         },
+#             {
+#             "href": "https://hpc.qhub.dev/",
+#             "title": "QHub HPC",
+#             "internal": False,
+
+#         },
+#             {
+#                 "href": "https://pypi.org/project/qhub/",
+#                 "title": "PyPI",
+#                 "internal": False,
+
+#         },
+#         ],
+
+#     }
+
+# html_sidebars = {
+#     "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
+#     }
+
+html_logo = "source/images/qhub_logo.png"
+
+# exclude build directory and Jupyter backup files:
 exclude_patterns = ["_build", "*checkpoint*", "site", "jupyter_execute", "conf.py", "README.md", "ext"]
 
 latex_documents = [

docs/index.md

@@ -1,5 +1,3 @@
-# QHub
-
 ![quansight_logo](source/images/qhub_logo.png)
 
 [![Python version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg)](https://pypi.org/project/qhub/)
@@ -10,7 +8,7 @@
 
 Open source tooling for data science research, development, and deployment.
 
-## What is Qhub?
+# What is Qhub?
 
 Integrated data science environment designed and developed by
 scientists at [**Quansight**](https://www.quansight.com/).  It enables
@@ -22,62 +20,32 @@ that streamlines the deployment of data science infrastructure.
 ## Contents
 
 ```{toctree}
-:maxdepth: 1
-:caption: Introduction
+:maxdepth: 2
 
-source/introduction.md
+source/introduction/index.md
 ```
 
 ```{toctree}
-:maxdepth: 1
-:caption: Installation
-
-source/installation/installation.md
-source/installation/setup.md
-source/installation/usage.md
-source/installation/configuration.md
-source/installation/management.md
-```
+:maxdepth: 2
+source/installation/index.md
+``` 
 
 ```{toctree}
-:maxdepth: 1
-:caption: User Guide
-
-source/user_guide/getting_started.md
-source/user_guide/code_server.md
-source/user_guide/ssh.md
-source/user_guide/dashboard.md
-source/user_guide/dask_gateway.md
-source/user_guide/faq.md
-source/user_guide/training.md
+:maxdepth: 2
+
+
+source/user_guide/index.md
 ```
 
 ```{toctree}
-:maxdepth: 1
-:caption: Administration Guide
-
-source/admin_guide/backup.md
-source/admin_guide/cost.md
-source/admin_guide/troubleshooting.md
-source/admin_guide/upgrade.md
-source/admin_guide/gpu.md
-source/admin_guide/preemptible-spot-instances.md
-source/admin_guide/system_maintenance.md
-source/admin_guide/monitoring.md
-source/admin_guide/clearml.md
-source/admin_guide/prefect.md
-source/admin_guide/faq.md
+:maxdepth: 2
+
+source/admin_guide/index.md
 ```
 
 ```{toctree}
-:maxdepth: 1
-:caption: Development Guide
-
-source/dev_guide/architecture.md
-source/dev_guide/contribution.md
-source/dev_guide/release.md
-source/dev_guide/testing.md
-source/dev_guide/changelog.md
-source/dev_guide/logo.md
+:maxdepth: 2
+
+source/dev_guide/index.md
 ```
 

docs/source/admin_guide/index.md

@@ -0,0 +1,17 @@
+# Administration Guide
+
+```{toctree}
+:maxdepth: 2
+
+backup.md
+cost.md
+troubleshooting.md
+upgrade.md
+gpu.md
+preemptible-spot-instances.md
+system_maintenance.md
+monitoring.md
+clearml.md
+prefect.md
+faq.md
+```

docs/source/dev_guide/index.md

@@ -0,0 +1,12 @@
+# Development Guide
+
+```{toctree}
+:maxdepth: 2
+
+architecture.md
+contribution.md
+release.md
+testing.md
+changelog.md
+logo.md
+```

docs/source/installation/index.md

@@ -0,0 +1,14 @@
+
+# Installation
+
+
+Installs stuff
+
+```{toctree}
+:maxdepth: 2
+installation.md
+setup.md
+usage.md
+configuration.md
+management.md
+```

docs/source/user_guide/index.md

@@ -0,0 +1,16 @@
+# User Guide
+
+
+User Guidy stuff
+
+```{toctree}
+:maxdepth: 2
+
+getting_started.md
+code_server.md
+ssh.md
+dashboard.md
+dask_gateway.md
+faq.md
+training.md
+```