Add NMDC logo to sidebar of workflows documentation

microbiomedata · Dec 13, 2024 · b562069 · b562069
1 parent f8d9114
commit b562069
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/ingesters/workflow_docs/_static/images/nmdc-logo-bg-white.png b/src/ingesters/workflow_docs/_static/images/nmdc-logo-bg-white.png
diff --git a/src/ingesters/workflow_docs/conf.py b/src/ingesters/workflow_docs/conf.py
@@ -32,6 +32,11 @@
 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path
 html_static_path = ['_static']
 
+# The path to the logo we want to use for the documentation website.
+# Note: This path is relative to the directory containing the `conf.py` file.
+# Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_logo
+html_logo = "_static/images/nmdc-logo-bg-white.png"
+
 # Register a custom favicon for the website.
 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon
 html_favicon = '_static/favicon.ico'