Added conf.py from MICM docs.

docs/source/conf.py

@@ -10,29 +10,35 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
+import os
+import sys
+import datetime
+sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'MUSICA'
-copyright = '2024, ACOM'
-author = 'ACOM'
-
-# The full version, including alpha/beta/rc tags
-release = '1.0'
+copyright = f'2024-{datetime.datetime.now().year}, NCAR/UCAR'
+author = 'NCAR/UCAR'
 
+suffix = ''
+# the suffix is required. This is controlled by the dockerfile that builds the docs
+release = f'0.0.0'
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+  'sphinx_copybutton',
+  'sphinx_design',
+  'sphinxcontrib.bibtex',
 ]
 
+bibtex_bibfiles = ['references.bib']
+suppress_warnings = ["bibtex.missing_field"]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -47,9 +53,23 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'pydata_sphinx_theme'
+
+html_theme_options = {
+    "external_links": [],
+    "github_url": "https://github.com/NCAR/musica",
+    "navbar_end": ["version-switcher", "navbar-icon-links"],
+   "pygment_light_style": "tango",
+   "pygment_dark_style": "monokai"
+}
+
+html_css_files = [
+    'custom.css'
+]
 
 # 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 = ['_static']
+html_static_path = ['_static']
+
+html_favicon = '_static/favicon/favicon.ico'

docs/source/index.rst

@@ -1,20 +1,54 @@
-.. MUSICA documentation master file, created by
-   sphinx-quickstart on Sun Mar 10 17:24:35 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. musica documentation HTML titles
+..
+.. # (over and under) for module headings
+.. = for sections
+.. - for subsections
+.. ^ for subsubsections
+.. ~ for subsubsubsections
+.. " for paragraphs
 
+==================================
 Welcome to MUSICA's documentation!
 ==================================
 
+.. grid:: 1 1 2 2
+    :gutter: 2
+
+    .. grid-item-card:: Getting started
+        :img-top: _static/index_getting_started.svg
+        :link: getting_started
+        :link-type: doc
+
+        Check out the getting started guide to build and install musica.
+
+    .. grid-item-card::  User guide
+        :img-top: _static/index_user_guide.svg
+        :link: user_guide/index
+        :link-type: doc
+
+    .. grid-item-card::  API reference
+        :img-top: _static/index_api.svg
+        :link: api/index
+        :link-type: doc
+
+    .. grid-item-card::  Contributors guide
+        :img-top: _static/index_contribute.svg
+        :link: contributing/index
+        :link-type: doc
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
+.. getting_started
+.. user_guide/index
+.. api/index
+.. contributing/index
+.. citing_and_bibliography/index
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`