updated doc

WilfriedMercier · Dec 19, 2023 · 86a56e8 · 86a56e8
1 parent b38fbbc
commit 86a56e8
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 23 deletions.
diff --git a/source/API/catalogues.rst b/source/API/catalogues.rst
@@ -3,7 +3,7 @@ Catalogue classes
 
 .. _Table.write(): https://docs.astropy.org/en/stable/api/astropy.table.Table.html#astropy.table.Table.write
 
-.. automodule:: SED.catalogues
+.. automodule:: pixSED.catalogues
     :members:
     :private-members:
     :show-inheritance:
diff --git a/source/API/filters.rst b/source/API/filters.rst
@@ -1,7 +1,7 @@
 Filter classes
 ==============
 
-.. automodule:: SED.filters
+.. automodule:: pixSED.filters
     :members:
     :private-members:
     :show-inheritance:
diff --git a/source/API/index.rst b/source/API/index.rst
@@ -19,46 +19,46 @@ API
             :link: catalogues
             :link-type: doc
 
-            Documentation related to :class:`~SED.catalogues.Catalogue` class and sub-classes.
+            Documentation related to :py:class:`~.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.
+            Documentation related to :py:class:`~.Filter` and :py:class:`~.FilterList` classes.
 
     .. grid-item::
 
         .. card:: Miscellaneous
             :link: misc/index
             :link-type: doc
 
-            Documentation related to :py:mod:`~SED.filters.misc` module.
+            Documentation related to various misc module.
 
     .. grid-item::
 
         .. card:: Outputs
             :link: outputs
             :link-type: doc
 
-            Documentation related to :py:class:`~SED.outputs.Output` class and sub-classes.
+            Documentation related to :py:class:`~.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`.
+            Documentation related to various functions related to photometric conversions defined in :py:mod:`~pixSED.photometry`.
 
     .. grid-item::
 
         .. card:: Sed objects
             :link: sed
             :link-type: doc
 
-            Documentation related to :py:class:`~SED.sed.SED` class and sub-classes.
+            Documentation related to :py:class:`~.SED` class and sub-classes.
 
 
diff --git a/source/API/misc/enum.rst b/source/API/misc/enum.rst
@@ -1,7 +1,7 @@
 Enumeration classes
 ===================
 
-.. automodule:: SED.misc.enum
+.. automodule:: pixSED.misc.enum
     :special-members: __str__
     :members:
     :private-members:

diff --git a/source/API/misc/index.rst b/source/API/misc/index.rst
@@ -42,4 +42,4 @@ Miscellaneous
             :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.
+            Documentation related to :py:class:`~.Property` class and sub-classes used to perform checks for physical properties with strict bounds or a restricted set of acceptable values.
diff --git a/source/API/misc/misc.rst b/source/API/misc/misc.rst
@@ -1,9 +1,7 @@
 Miscellaneous classes and functions
 ===================================
 
-.. _ndarray: https://numpy.org/doc/stable/reference/generated/numpy.array.html
-
-.. automodule:: SED.misc.misc
+.. automodule:: pixSED.misc.misc
     :special-members: __str__
     :members:
     :private-members:

diff --git a/source/API/misc/properties.rst b/source/API/misc/properties.rst
@@ -1,7 +1,7 @@
 Property classes
 ================
 
-.. automodule:: SED.misc.properties
+.. automodule:: pixSED.misc.properties
     :special-members: __str__
     :members:
     :private-members:

diff --git a/source/API/outputs.rst b/source/API/outputs.rst
@@ -1,7 +1,7 @@
 SED fitting code output classes
 ===============================
 
-.. automodule:: SED.outputs
+.. automodule:: pixSED.outputs
     :members:
     :private-members:
     :show-inheritance:
diff --git a/source/API/photometry.rst b/source/API/photometry.rst
@@ -1,7 +1,7 @@
 Photometry related fonctions
 ============================
 
-.. automodule:: SED.photometry
+.. automodule:: pixSED.photometry
     :members:
     :private-members:
     :show-inheritance:
diff --git a/source/API/sed.rst b/source/API/sed.rst
@@ -3,7 +3,7 @@ SED classes
 
 .. _TextIOBase: https://docs.python.org/3/library/io.html#io.TextIOBase
 
-.. automodule:: SED.sed
+.. automodule:: pixSED.sed
     :members:
     :private-members:
     :show-inheritance:
diff --git a/source/docutils.conf b/source/docutils.conf
diff --git a/source/index.rst b/source/index.rst
@@ -5,7 +5,7 @@
     setup
     nomenclature
     poisson
-    examples/index
+    examples
     API/index
 
 Introduction
@@ -71,7 +71,7 @@ Whatever the backend, the first step is to load the data. To do so, two classes
 
 .. code-block::
 
-    import SED
+    import pixSED as SED
 
     filt_435w = SED.Filter('F435W', 'data_F435W.fits', 'var_F435W.fits', 25.68, file2 = None)
 
@@ -198,8 +198,8 @@ Similarly, to change the bad pixel cleaning method, one can do
 
     The code automatically cleans bad pixels which are identified as having either a negative flux or a negative variance. Two cleaning methods are proposed:
 
-    - :py:attr:`SED.misc.enum.CleanMethod.ZERO` which replaces bad pixels by a flux equal to 0 and 
-    - :py:attr:`SED.misc.enum.CleanMethod.MIN` which replaces bad pixels with the minimum value in the masked image.
+    - :py:attr:`pixSED.misc.enum.CleanMethod.ZERO` which replaces bad pixels by a flux equal to 0 and 
+    - :py:attr:`pixSED.misc.enum.CleanMethod.MIN` which replaces bad pixels with the minimum value in the masked image.
 
 There is also the possibility to update the SED fitting code backend as follows: