Standardize comments added to conf.py

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

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/content/nmdc/src/conf.py b/content/nmdc/src/conf.py
@@ -66,13 +66,18 @@
 html_css_files = [
     'css/custom.css',
 ]
+
+# 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"
 
 # Register a custom JavaScript script for the website to load.
+# Note: These paths are relative to the `{html_static_path}` directory.
 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_js_files
 html_js_files = [
     "js/index.js"

diff --git a/legacy/nmdc-documentation/src/conf.py b/legacy/nmdc-documentation/src/conf.py
@@ -66,12 +66,18 @@
 html_css_files = [
     'css/custom.css',
 ]
+
+# 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"
 
 # Register a custom JavaScript script for the website to load.
+# Note: These paths are relative to the `{html_static_path}` directory.
 # Reference: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_js_files
 html_js_files = [
     "js/index.js"