Merge main to develop branch

.readthedocs.yml

@@ -26,5 +26,10 @@ build:
       - "jupyter-book config sphinx docs/"
       - "pip install . --no-deps"
 
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+
 conda:
   environment: docs/environment.yml

README.rst

@@ -164,7 +164,7 @@ The use of Third Party Software is governed by the terms of such software licens
 Third Party Software notices and/or additional terms and conditions are located in the
 `THIRD_PARTY_SOFTWARE.rst`_ file.
 
-.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
+.. _THIRD_PARTY_SOFTWARE.rst: docs/THIRD_PARTY_SOFTWARE.rst
 
 Copyright
 ^^^^^^^^^

THIRD_PARTY_SOFTWARE.rst → docs/THIRD_PARTY_SOFTWARE.rst

@@ -1,3 +1,6 @@
+Third Party Software
+====================
+
 The simpeg-drivers repository and source distributions bundle several libraries that are
 compatibly licensed.  We list these here.
 
@@ -8,7 +11,7 @@ compatibly licensed.  We list these here.
    * - Name
      - License
      - Description
-   * - `dask <https://github.com/dask/dask`_
+   * - `dask <https://github.com/dask/dask>`_
      - BSD-3-Clause
      - Parallel PyData with Task Scheduling
    * - `discretize <https://simpeg.xyz/>`_

docs/_toc.yml

@@ -20,3 +20,4 @@ chapters:
   - file: case_study/tipper
   - file: case_study/airborne_tem
   - file: case_study/joint_inversion
+- file: THIRD_PARTY_SOFTWARE

docs/conf.py

@@ -0,0 +1,63 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+from importlib.metadata import version
+from datetime import datetime
+from packaging.version import Version
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "simpeg-drivers"
+
+# The full version, including alpha/beta/rc tags.
+release = version("simpeg-drivers")
+# The short X.Y.Z version.
+version = Version(release).base_version
+
+project_copyright = "%Y, Mira Geoscience Ltd"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+autodoc_mock_imports = [
+    "geoapps_utils",
+    "geoh5py",
+    "numpy",
+]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.todo",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+todo_include_todos = True
+
+# -- Options for auto-doc ----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
+
+autodoc_typehints = "signature"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_theme_options = {
+    "description": f"version {release}",
+}
+
+# Enable numref
+numfig = True
+
+
+def get_copyright_notice():
+    return f"Copyright {datetime.now().strftime(project_copyright)}"
+
+
+rst_epilog = f"""
+.. |copyright_notice| replace:: {get_copyright_notice()}.
+"""

pyproject.toml

@@ -39,7 +39,7 @@ scipy = "~1.14.0"
 
 ## Pip dependencies from Git repositories
 #----------------------------------------
-#geoh5py = {version = ">=0.10.0rc1, <0.11.0a.dev", source = "pypi", allow-prereleases = true}
+#geoh5py = {version = ">=0.10.1rc1, <0.11.0a.dev", source = "pypi", allow-prereleases = true}
 geoh5py = {git = "https://github.com/MiraGeoscience/geoh5py.git", rev = "develop"}
 
 #octree-creation-app = {version = ">=0.2.0rc1, <0.3.0a.dev", source = "pypi", allow-prereleases = true}