updated the documentation

source/API/index.rst

@@ -2,10 +2,63 @@ API
 ===
 
 .. toctree::
+    :hidden:
 
     catalogues
     filters
     misc/index
     outputs
     photometry
     sed
+
+.. grid:: 2
+
+    .. grid-item::
+
+        .. card:: Catalogues
+            :link: catalogues
+            :link-type: doc
+
+            Documentation related to :class:`~SED.catalogues.Catalogue` class and sub-classes.
+
+    .. grid-item::
+
+        .. card:: Filters
+            :link: filters
+            :link-type: doc
+
+            Documentation related to :class:`~SED.filters.Filter` and :class:`~SED.filters.FilterList` classes.
+
+    .. grid-item::
+
+        .. card:: Miscellaneous
+            :link: misc/index
+            :link-type: doc
+
+            Documentation related to :py:mod:`~SED.filters.misc` module.
+
+    .. grid-item::
+
+        .. card:: Outputs
+            :link: outputs
+            :link-type: doc
+
+            Documentation related to :py:class:`~SED.outputs.Output` class and sub-classes.
+
+    .. grid-item::
+
+        .. card:: Photometry
+            :link: photometry
+            :link-type: doc
+
+            Documentation related to various functions related to photometric conversions defined in :py:mod:`~SED.photometry`.
+
+    .. grid-item::
+
+        .. card:: Sed objects
+            :link: sed
+            :link-type: doc
+
+            Documentation related to :py:class:`~SED.sed.SED` class and sub-classes.
+
+

source/API/misc/index.rst

@@ -2,7 +2,44 @@ Miscellaneous
 =============
 
 .. toctree::
+    :hidden:
 
+    cigaleModules/index
     enum
     misc
     properties
+
+
+.. grid:: 2
+
+    .. grid-item::
+
+        .. card:: Modules for Cigale_
+            :link: cigaleModules/index
+            :link-type: doc
+
+            Documentation related to all the modules that can be used with Cigale_.
+
+    .. grid-item::
+
+        .. card:: Custom enumerations
+            :link: enum
+            :link-type: doc
+
+            Documentation related to custom enumerations used throughout the library.
+
+    .. grid-item::
+
+        .. card:: Miscellaneous
+            :link: misc
+            :link-type: doc
+
+            Documentation related to a collection of custom objects, including errors, classes, and decorators.
+
+    .. grid-item::
+
+        .. card:: Properties
+            :link: properties
+            :link-type: doc
+
+            Documentation related to :py:class:`~SED.misc.properties.Property` class and sub-classes used to perform checks for physical properties with strict bounds or a restricted set of acceptable values.

source/conf.py

@@ -15,27 +15,25 @@ def skip(app, what, name, obj, would_skip, options):
 #               Project information               #
 ###################################################
 
-project            = 'Resolved SED-fitting wrapper'
-copyright          = '2021, Wilfried Mercier'
+project            = 'pixSED'
+copyright          = '2023, Wilfried Mercier'
 author             = 'Wilfried Mercier'
 show_authors       = True
 
 highlight_options  = {'default': {'lexers.python.PythonLexer'},
                      }
 
 extensions         = ['sphinx.ext.autodoc',
-#                      'sphinx.ext.imgmath',
                       'sphinx.ext.mathjax',
                       'sphinx.ext.viewcode',
                       'sphinx.ext.autosummary',
-                      'matplotlib.sphinxext.plot_directive',
-                      #'sphinx_copybutton',
-                      'sphinx_execute_code',
                       'sphinx.ext.intersphinx',
+                      'jupyter_sphinx',
+                      "sphinx_design"
                      ]
 
 # The full version, including alpha/beta/rc tags
-release            = '0.5'
+release            = '1.0'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path     = ['_templates']
@@ -46,13 +44,39 @@ def skip(app, what, name, obj, would_skip, options):
 #######################################################
 
 #html_theme         = 'karma_sphinx_theme'
-html_theme = "sphinxawesome_theme"
+#html_theme = "sphinxawesome_theme"
 # html_logo          = "path/to/my/logo.png"
+html_theme = "pydata_sphinx_theme"
 
-html_theme_options = {'extra_header_links' : {
-                      "GitHub": "https://github.com/WilfriedMercier/SED"
-                     },
-    }
+
+html_title = 'pixSED'
+
+# Force light mode by default
+html_context = {"default_mode" : "light"}
+
+html_theme_options = {
+    "icon_links": [
+        {
+            # Label for this link
+            "name": "GitHub",
+
+            # URL where the link will redirect
+            "url": "https://github.com/WilfriedMercier/SED",
+
+            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
+            "icon": "fa-brands fa-square-github",
+
+            # The type of image to be used (see below for details)
+            "type": "fontawesome",
+        }],
+
+    "announcement" : "Support for LePhare is currently deprecated as it relies on the old Fortran version. Please use Cigale instead.",
+    "show_nav_level" : 2
+}
+
+# Add sypport for custom css file
+html_static_path = ["_static"]
+html_css_files   = ["mycss.css"]
 
 html_collapsible_definitions = True
 
@@ -65,5 +89,7 @@ def skip(app, what, name, obj, would_skip, options):
 .. _Astropy Quantity: https://docs.astropy.org/en/stable/units/quantity.html
 .. _Astropy Header: https://docs.astropy.org/en/stable/io/fits/api/headers.html
 .. _ndarray: https://numpy.org/doc/stable/reference/generated/numpy.array.html
+.. _Cigale: https://cigale.lam.fr/
+.. _LePhare: https://cesam.lam.fr/lephare/lephare.html
 """