Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robertdstein committed May 20, 2024
1 parent 7d7b08f commit 5275d84
Show file tree
Hide file tree
Showing 14 changed files with 308 additions and 27 deletions.
50 changes: 50 additions & 0 deletions docs/source/mirar.catalog.base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
mirar.catalog.base package
==========================

.. automodule:: mirar.catalog.base
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.catalog.base.base\_catalog module
---------------------------------------

.. automodule:: mirar.catalog.base.base_catalog
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.base.base\_gaia module
------------------------------------

.. automodule:: mirar.catalog.base.base_gaia
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.base.base\_xmatch\_catalog module
-----------------------------------------------

.. automodule:: mirar.catalog.base.base_xmatch_catalog
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.base.catalog\_from\_file module
---------------------------------------------

.. automodule:: mirar.catalog.base.catalog_from_file
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.base.errors module
--------------------------------

.. automodule:: mirar.catalog.base.errors
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/source/mirar.catalog.kowalski.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ mirar.catalog.kowalski.base\_kowalski\_catalog module
:undoc-members:
:show-inheritance:

mirar.catalog.kowalski.gaia module
----------------------------------

.. automodule:: mirar.catalog.kowalski.gaia
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.kowalski.ps1 module
---------------------------------

Expand Down
18 changes: 18 additions & 0 deletions docs/source/mirar.catalog.multibackend.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
mirar.catalog.multibackend package
==================================

.. automodule:: mirar.catalog.multibackend
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.catalog.multibackend.gaia2mass module
-------------------------------------------

.. automodule:: mirar.catalog.multibackend.gaia2mass
:members:
:undoc-members:
:show-inheritance:
22 changes: 3 additions & 19 deletions docs/source/mirar.catalog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,8 @@ Subpackages
.. toctree::
:maxdepth: 4

mirar.catalog.base
mirar.catalog.kowalski
mirar.catalog.multibackend
mirar.catalog.tap
mirar.catalog.vizier

Submodules
----------

mirar.catalog.base\_catalog module
----------------------------------

.. automodule:: mirar.catalog.base_catalog
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.gaia module
-------------------------

.. automodule:: mirar.catalog.gaia
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/source/mirar.catalog.tap.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
mirar.catalog.tap package
=========================

.. automodule:: mirar.catalog.tap
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.catalog.tap.gaia2mass module
----------------------------------

.. automodule:: mirar.catalog.tap.gaia2mass
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/source/mirar.catalog.vizier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ mirar.catalog.vizier.base\_vizier\_catalog module
:undoc-members:
:show-inheritance:

mirar.catalog.vizier.gaia2mass module
-------------------------------------

.. automodule:: mirar.catalog.vizier.gaia2mass
:members:
:undoc-members:
:show-inheritance:

mirar.catalog.vizier.ps1 module
-------------------------------

Expand Down
1 change: 1 addition & 0 deletions docs/source/mirar.pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Subpackages

mirar.pipelines.sedmv2
mirar.pipelines.summer
mirar.pipelines.wasp
mirar.pipelines.winter
mirar.pipelines.wirc

Expand Down
18 changes: 18 additions & 0 deletions docs/source/mirar.pipelines.wasp.config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
mirar.pipelines.wasp.config package
===================================

.. automodule:: mirar.pipelines.wasp.config
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.pipelines.wasp.config.constants module
--------------------------------------------

.. automodule:: mirar.pipelines.wasp.config.constants
:members:
:undoc-members:
:show-inheritance:
50 changes: 50 additions & 0 deletions docs/source/mirar.pipelines.wasp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
mirar.pipelines.wasp package
============================

.. automodule:: mirar.pipelines.wasp
:members:
:undoc-members:
:show-inheritance:

Subpackages
-----------

.. toctree::
:maxdepth: 4

mirar.pipelines.wasp.config

Submodules
----------

mirar.pipelines.wasp.blocks module
----------------------------------

.. automodule:: mirar.pipelines.wasp.blocks
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.wasp.generator module
-------------------------------------

.. automodule:: mirar.pipelines.wasp.generator
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.wasp.load\_wasp\_image module
---------------------------------------------

.. automodule:: mirar.pipelines.wasp.load_wasp_image
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.wasp.wasp\_pipeline module
------------------------------------------

.. automodule:: mirar.pipelines.wasp.wasp_pipeline
:members:
:undoc-members:
:show-inheritance:
66 changes: 66 additions & 0 deletions docs/source/mirar.pipelines.winter.generator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
mirar.pipelines.winter.generator package
========================================

.. automodule:: mirar.pipelines.winter.generator
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.pipelines.winter.generator.astrometry module
--------------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.astrometry
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.candidates module
--------------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.candidates
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.photometry module
--------------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.photometry
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.realbogus module
-------------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.realbogus
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.reduce module
----------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.reduce
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.references module
--------------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.references
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator.utils module
---------------------------------------------

.. automodule:: mirar.pipelines.winter.generator.utils
:members:
:undoc-members:
:show-inheritance:
17 changes: 9 additions & 8 deletions docs/source/mirar.pipelines.winter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Subpackages
:maxdepth: 4

mirar.pipelines.winter.config
mirar.pipelines.winter.generator
mirar.pipelines.winter.models

Submodules
Expand Down Expand Up @@ -58,14 +59,6 @@ mirar.pipelines.winter.fourier\_bkg\_model module
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.generator module
---------------------------------------

.. automodule:: mirar.pipelines.winter.generator
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.ingest\_references module
------------------------------------------------

Expand All @@ -82,6 +75,14 @@ mirar.pipelines.winter.load\_winter\_image module
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.run module
---------------------------------

.. automodule:: mirar.pipelines.winter.run
:members:
:undoc-members:
:show-inheritance:

mirar.pipelines.winter.validator module
---------------------------------------

Expand Down
18 changes: 18 additions & 0 deletions docs/source/mirar.processors.sources.machine_learning.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
mirar.processors.sources.machine\_learning package
==================================================

.. automodule:: mirar.processors.sources.machine_learning
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

mirar.processors.sources.machine\_learning.pytorch module
---------------------------------------------------------

.. automodule:: mirar.processors.sources.machine_learning.pytorch
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 5275d84

Please sign in to comment.