setting up new documentation

NCAR · Aug 12, 2024 · d418d76 · d418d76
1 parent 70d3c0c
commit d418d76
Show file tree

Hide file tree

Showing 14 changed files with 387 additions and 14 deletions.
diff --git a/doc/source/_static/MusicBox.png b/doc/source/_static/MusicBox.png
diff --git a/doc/source/_static/MusicBox.svg b/doc/source/_static/MusicBox.svg
diff --git a/doc/source/_static/custom.css b/doc/source/_static/custom.css
@@ -0,0 +1,7 @@
+.sd-card-img-top {
+  width: 33% !important;
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  margin-top: 10px;
+}
diff --git a/doc/source/_static/index_api.svg b/doc/source/_static/index_api.svg
diff --git a/doc/source/_static/index_contribute.svg b/doc/source/_static/index_contribute.svg
diff --git a/doc/source/_static/index_getting_started.svg b/doc/source/_static/index_getting_started.svg
diff --git a/doc/source/_static/index_user_guide.svg b/doc/source/_static/index_user_guide.svg
diff --git a/doc/source/acom_music_box.rst → doc/source/api/acom_music_box.rst b/doc/source/acom_music_box.rst → doc/source/api/acom_music_box.rst
@@ -1,5 +1,5 @@
-acom\_music\_box package
-========================
+MusicBox
+========
 
 Submodules
 ----------

diff --git a/doc/source/modules.rst → doc/source/api/index.rst b/doc/source/modules.rst → doc/source/api/index.rst
@@ -1,5 +1,6 @@
-acom_music_box
-==============
+###
+API
+###
 
 .. toctree::
    :maxdepth: 4

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -1,6 +1,7 @@
 import sys
 import os
 import datetime
+import acom_music_box
 sys.path.insert(0, os.path.abspath('..'))
 
 # Configuration file for the Sphinx documentation builder.
@@ -11,7 +12,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'Music Box'
+release = acom_music_box.__version__
+project = f'Music Box ({release})'
 copyright = f'2024-{datetime.datetime.now().year}, NCAR/UCAR'
 author = 'NCAR/UCAR'
 
@@ -27,20 +29,24 @@
 templates_path = ['_templates']
 exclude_patterns = []
 
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_static_path = ['_static']
 html_theme = 'pydata_sphinx_theme'
 
 html_theme_options = {
+    "navbar_start": ["navbar-logo", "version-switcher"],
     "external_links": [],
     "github_url": "https://github.com/NCAR/music-box",
-    "navbar_end": ["version-switcher", "navbar-icon-links"],
+    "navbar_end": ["theme-switcher", "navbar-icon-links"],
     "pygment_light_style": "tango",
     "pygment_dark_style": "monokai"
 }
 
-html_favicon = '_static/favicon.png'
+html_css_files = [
+    'custom.css'
+]
+
+html_favicon = '_static/favicon.png'
+html_logo = "_static/MusicBox.svg"
diff --git a/doc/source/contributing/index.rst b/doc/source/contributing/index.rst
@@ -0,0 +1,3 @@
+############
+Contributing
+############
diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
@@ -0,0 +1,3 @@
+###############
+Getting Started
+###############