Initial push

Author: jramsdell-bt

.DS_Store

@@ -13,10 +13,10 @@ jobs:
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser pydata-sphinx-theme
+          pip install sphinx sphinx_rtd_theme pydata-sphinx-theme sphinx-design
       - name: Sphinx build
         run: |
-          sphinx-build doc _build
+          sphinx-build docs _build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+
+/* Add horizontal ruler below Header level 1 */
+h1
+{
+    border-bottom:3px solid #CCC;
+    padding-bottom:3px;
+}
+
+/* Add horizontal ruler below Header level 2 */
+h2
+{
+    border-bottom:3px solid #CCC;
+    padding-bottom:3px;
+}
+
+/* Stretch central panel to fit to maximum width */
+
+.bd-main .bd-content .bd-article-container {
+    max-width: 100%;  /* default is 60em */
+  }
+
+/* Shrinks the left sidebar so it takes up less space */
+.bd-sidebar-primary {
+    width: 20%
+
+}
+
+/* Change link colors to blue, among other things */
+html[data-theme="light"] {
+    --pst-color-primary: blue;
+}
+
+html[data-theme="dark"] {
+    --pst-color-primary: rgb(0, 174, 255);
+}

Makefile

@@ -17,13 +17,13 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Demo for Sphinx Documentation"
-copyright = "N/A"
+project = "BioTeam Sphinx Demo"
+copyright ="BioTeam Inc"
 author = "Jordan Ramsdell"
-github_user = "bioteam"
+github_user = "jramsdell"
 github_repo_name = "sphinx-documentation-demo"  # auto-detected from dirname if blank
 github_version = "main"
-conf_py_path = "/doc/" # with leading and trailing slash
+conf_py_path = "/docs/" # with leading and trailing slash
 
 # -- General configuration ---------------------------------------------------
 
@@ -33,6 +33,7 @@
 extensions = [
     # githubpages just adds a .nojekyll file
     "sphinx.ext.githubpages",
+    "sphinx_design"
 ]
 
 # Settings for myst_nb:
@@ -56,21 +57,43 @@
 
 
 # -- Options for HTML output -------------------------------------------------
+html_theme = "pydata_sphinx_theme" # To install a new theme, you have to pip install it first
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+  "use_edit_page_button": False,
+  "show_toc_level": 4,
+
+
+  # SHOW_NAV_LEVEL: Normally for the left sidebar, deeply nested items are collapsed.
+  #                 We can change the defualt maximum depth by changing the nav level
+  "show_nav_level": 2,
+#   "navbar_center": ["navbar-nav"],
+
+  # LOGO: This determines the text (and icon, if you have one) that you see
+  #       in the upper left-hand corner of the page
+  "logo": {
+      "text": "BioTeam Sphinx Demo"
+  }
+}
+html_show_sourcelink = False
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['css']
+html_static_path = ['_static']
+html_css_files = [
+    'css/custom.css'
+]
 
 
 # HTML context:
 from os.path import basename, dirname, realpath
 
+
+# html_sidebars = {
+#     "**": ["globaltoc.html"]
+# }
+
 html_context = {
     "display_github": True,
     "github_user": github_user,
@@ -81,23 +104,3 @@
     "conf_py_path": conf_py_path,
 }
 
-import os
-if os.environ.get('GITHUB_REF', '') == 'refs/heads/'+github_version:
-    html_js_files = [
-        ('https://plausible.cs.aalto.fi/js/script.js', {"data-domain": "coderefinery.github.io", "defer": "defer"}),
-    ]
-
-# Intersphinx mapping.  For example, with this you can use
-# :py:mod:`multiprocessing` to link straight to the Python docs of that module.
-# List all available references:
-#   python -msphinx.ext.intersphinx https://docs.python.org/3/objects.inv
-# extensions.append('sphinx.ext.intersphinx')
-# intersphinx_mapping = {
-#    #'python': ('https://docs.python.org/3', None),
-#    #'sphinx': ('https://www.sphinx-doc.org/', None),
-#    #'numpy': ('https://numpy.org/doc/stable/', None),
-#    #'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
-#    #'pandas': ('https://pandas.pydata.org/docs/', None),
-#    #'matplotlib': ('https://matplotlib.org/', None),
-#    'seaborn': ('https://seaborn.pydata.org/', None),
-# }