Test the Docs Preview

doc/conf.py

@@ -1,19 +1,19 @@
 # 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
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import pathlib
+import importlib.util
 
+# -- Project information -----------------------------------------------------
 project = "deapi"
 copyright = "2024, DE Developers"
 author = "DE Developers"
-release = "0.1.0"
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+from deapi.version import version
 
+release = version
+
+# -- General configuration ---------------------------------------------------
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
@@ -24,41 +24,31 @@
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-
 # -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+# Ensure pydata-sphinx-theme is available
+if importlib.util.find_spec("pydata_sphinx_theme") is None:
+    raise RuntimeError("pydata-sphinx-theme is not installed in this environment")
 
 html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
 html_logo = "_static/de_api_icon.svg"
 
 master_doc = "index"
 
-
-# sphinx.ext.autodoc
-# ------------------
-# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
+# -- Autodoc / Autosummary ---------------------------------------------------
 autosummary_ignore_module_all = False
 autosummary_imported_members = True
 autodoc_typehints_format = "short"
-autodoc_default_options = {
-    "show-inheritance": True,
-}
-
+autodoc_default_options = {"show-inheritance": True}
 autosummary_generate = True
 
-# sphinx_gallery
-# --------------
-# https://sphinx-gallery.github.io/stable/configuration.html
-
+# -- Sphinx Gallery ----------------------------------------------------------
 sphinx_gallery_conf = {
     "examples_dirs": "../examples",
     "gallery_dirs": "examples",
     "filename_pattern": "^((?!sgskip).)*$",
     "ignore_pattern": "_sgskip.py",
     "backreferences_dir": "api",
     "doc_module": ("deapi",),
-    "reference_url": {
-        "deapi": None,
-    },
+    "reference_url": {"deapi": None},
 }

doc/intro.rst

@@ -10,6 +10,7 @@ Examples of usage can be found in the `Examples` directory which give an idea of
 the functionality of the package and can be used as a starting point.
 
 
+
 Installation
 ------------
 The package can be installed using pip, or with conda from the conda-forge channel.