start organizing docs

docs/conf.py

@@ -23,6 +23,7 @@
 # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
 extensions = [
+    "sphinxcontrib.bibtex",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
@@ -34,6 +35,7 @@
     "sphinx.ext.mathjax",
     "sphinx_automodapi.automodapi",
     "sphinx_automodapi.smart_resolver",
+    "sphinx_gallery.gen_gallery",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -57,26 +59,21 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"python": ("https://docs.python.org/", None)}
-
+intersphinx_mapping = {
+    "python": (
+        "https://docs.python.org/3/",
+        (None, "http://www.astropy.org/astropy-data/intersphinx/python3.inv"),
+    ),
+    "numpy": (
+        "https://numpy.org/doc/stable/",
+        (None, "http://www.astropy.org/astropy-data/intersphinx/numpy.inv"),
+    ),
+    "astropy": ("https://docs.astropy.org/en/stable/", None),
+}
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
-
-# 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"]
-
-# By default, when rendering docstrings for classes, sphinx.ext.autodoc will
-# make docs with the class-level docstring and the class-method docstrings,
-# but not the __init__ docstring, which often contains the parameters to
-# class constructors across the scientific Python ecosystem. The option below
-# will append the __init__ docstring to the class-level docstring when rendering
-# the docs. For more options, see:
-# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content
-autoclass_content = "both"
+html_theme = "pydata-sphinx-theme"
 
 # -- Other options ----------------------------------------------------------

docs/index.rst

@@ -1,15 +1,10 @@
 ebtelplusplus Documentation
----------------------------
+===========================
 
 This is the documentation for ebtelplusplus.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+   :hidden:
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   reference

docs/reference.rst

@@ -0,0 +1,9 @@
+.. _ebtelplusplus-reference:
+
+API Reference
+=============
+
+.. automodapi:: ebtelplusplus
+
+.. automodapi:: ebtelplusplus.models
+

pyproject.toml

@@ -63,7 +63,11 @@ docs = [
   "ebtelplusplus[all]",
   "sphinx>=7.0",
   "sphinx-automodapi",
-  "sphinx_copybutton",
+  "sphinxcontrib-bibtex",
+  "pydata-sphinx-theme",
+  "sphinx-design",
+  "sphinx-gallery",
+  "matplotlib",
 ]
 dev = ["ebtelplusplus[test,docs]"]