Api/restructure

.gitignore

@@ -1,14 +1,19 @@
-.idea
-*__pycache__
+.idea/
+__pycache__/
+*.py[cod]
 logs/
 plots_tests/
-*.egg-info
-venv
-build
-dist
-.tox
-.cache
-docs/_build
+venv/
+.tox/
+.cache/
+
+docs/_build/
+docs/_generated/
+
+*.egg-info/
+.eggs/
+build/
+dist/
 
 # Notebooks
 *.ipynb
@@ -17,6 +22,7 @@ notebooks/
 notebooks/plots/*.png
 notebooks/plots/*.pdf
 notebooks/logs/
-docs/_generated/
+
 unused/
 src/lfkit/_version.py
+.DS_Store

docs/about/photometry_overview.rst

@@ -40,7 +40,7 @@ distance, and sometimes additional photometric corrections.
 
 For worked examples of the LFKit public API, see the dedicated example pages:
 
-- :doc:`../examples/luminosity_function_models`
+- :doc:`../examples/lf_models/index`
 - :doc:`../examples/magnitudes_and_luminosities`
 - :doc:`../examples/magnitude_integrals`
 - :doc:`../examples/redshift_density`

docs/api/index.rst

@@ -1,7 +1,16 @@
-API Reference
+API reference
 =============
 
-.. toctree::
-   :maxdepth: 2
+.. autosummary::
+   :toctree:
+   :recursive:
 
-   lfkit
+   lfkit
+   lfkit.api
+   lfkit.api.luminosity_function
+   lfkit.api.conditional_luminosity_function
+   lfkit.api.corrections
+   lfkit.luminosity_functions
+   lfkit.photometry
+   lfkit.corrections
+   lfkit.cosmo

docs/api/lfkit.api.conditional_luminosity_function.rst

@@ -1,7 +1,12 @@
-lfkit.api.conditional\_luminosity\_function module
-==================================================
+lfkit.api.conditional\_luminosity\_function
+===========================================
 
 .. automodule:: lfkit.api.conditional_luminosity_function
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ConditionalLuminosityFunction
+

docs/api/lfkit.api.corrections.rst

@@ -1,7 +1,12 @@
-lfkit.api.corrections module
-============================
+lfkit.api.corrections
+=====================
 
 .. automodule:: lfkit.api.corrections
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Corrections
+

docs/api/lfkit.api.luminosity_function.rst

@@ -1,7 +1,12 @@
-lfkit.api.luminosity\_function module
-=====================================
+lfkit.api.luminosity\_function
+==============================
 
 .. automodule:: lfkit.api.luminosity_function
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      LuminosityFunction
+

docs/api/lfkit.api.rst

@@ -1,20 +1,15 @@
-lfkit.api package
-=================
+lfkit.api
+=========
 
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 2
+.. automodule:: lfkit.api
 
-   lfkit.api.conditional_luminosity_function
-   lfkit.api.corrections
-   lfkit.api.luminosity_function
+
+.. rubric:: Modules
 
-Module contents
----------------
+.. autosummary::
+   :toctree:
+   :recursive:
 
-.. automodule:: lfkit.api
-   :members:
-   :show-inheritance:
-   :undoc-members:
+   conditional_luminosity_function
+   corrections
+   luminosity_function

docs/api/lfkit.corrections.color_anchors.rst

@@ -1,7 +1,12 @@
-lfkit.corrections.color\_anchors module
-=======================================
+lfkit.corrections.color\_anchors
+================================
 
 .. automodule:: lfkit.corrections.color_anchors
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      fit_coeffs_from_bandcolor
+

docs/api/lfkit.corrections.filters.rst

@@ -1,7 +1,17 @@
-lfkit.corrections.filters module
-================================
+lfkit.corrections.filters
+=========================
 
 .. automodule:: lfkit.corrections.filters
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      list_supported
+      make_response_map
+      normalize_band
+      normalize_filterset
+      resolve_response_name
+      validate_coverage
+

docs/api/lfkit.corrections.kcorrect_backend.rst

@@ -1,7 +1,12 @@
-lfkit.corrections.kcorrect\_backend module
-==========================================
+lfkit.corrections.kcorrect\_backend
+===================================
 
 .. automodule:: lfkit.corrections.kcorrect_backend
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_kcorrect
+

docs/api/lfkit.corrections.kcorrect_from_color.rst

@@ -1,7 +1,12 @@
-lfkit.corrections.kcorrect\_from\_color module
-==============================================
+lfkit.corrections.kcorrect\_from\_color
+=======================================
 
 .. automodule:: lfkit.corrections.kcorrect_from_color
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      kcorrect_from_bandcolor
+

docs/api/lfkit.corrections.kcorrect_grids.rst

@@ -1,7 +1,14 @@
-lfkit.corrections.kcorrect\_grids module
-========================================
+lfkit.corrections.kcorrect\_grids
+=================================
 
 .. automodule:: lfkit.corrections.kcorrect_grids
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_kcorr_grid_package
+      compute_k_table
+      kcorr_interpolators
+

docs/api/lfkit.corrections.poggianti1997.rst

@@ -1,7 +1,21 @@
-lfkit.corrections.poggianti1997 module
-======================================
+lfkit.corrections.poggianti1997
+===============================
 
 .. automodule:: lfkit.corrections.poggianti1997
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      available_pairs
+      describe_poggianti1997_available
+      extract_sed_spectrum
+      load_poggianti1997_tables
+      make_ecorr_interpolator
+      make_kcorr_interpolator
+      poggianti1997_lookback_time_gyr
+      poggianti1997_time_since_bb_gyr
+      poggianti1997_to_accelerating_redshift
+      z_from_lookback_time
+

docs/api/lfkit.corrections.responses.rst

@@ -1,7 +1,16 @@
-lfkit.corrections.responses module
-==================================
+lfkit.corrections.responses
+===========================
 
 .. automodule:: lfkit.corrections.responses
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      discover_response_dir_auto
+      kcorrect_supports_response_dir
+      list_available_responses
+      require_responses
+      write_kcorrect_response
+

docs/api/lfkit.corrections.rst

@@ -1,24 +1,19 @@
-lfkit.corrections package
-=========================
+lfkit.corrections
+=================
 
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 2
+.. automodule:: lfkit.corrections
 
-   lfkit.corrections.color_anchors
-   lfkit.corrections.filters
-   lfkit.corrections.kcorrect_backend
-   lfkit.corrections.kcorrect_from_color
-   lfkit.corrections.kcorrect_grids
-   lfkit.corrections.poggianti1997
-   lfkit.corrections.responses
+
+.. rubric:: Modules
 
-Module contents
----------------
+.. autosummary::
+   :toctree:
+   :recursive:
 
-.. automodule:: lfkit.corrections
-   :members:
-   :show-inheritance:
-   :undoc-members:
+   color_anchors
+   filters
+   kcorrect_backend
+   kcorrect_from_color
+   kcorrect_grids
+   poggianti1997
+   responses

docs/api/lfkit.cosmo.cosmology.rst

@@ -1,7 +1,17 @@
-lfkit.cosmo.cosmology module
-============================
+lfkit.cosmo.cosmology
+=====================
 
 .. automodule:: lfkit.cosmo.cosmology
-   :members:
-   :show-inheritance:
-   :undoc-members:
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      comoving_distance_mpc
+      cosmo_object
+      differential_comoving_volume
+      distance_modulus
+      lookback_time_gyr
+      luminosity_distance_mpc
+