Skip to content

Commit 1420361

Browse files
rhandbergrhandberg
committed
Moved documentation to individual modules
1 parent d74e722 commit 1420361

22 files changed

+242
-0
lines changed

‎docs/make_catalog.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`make_catalog.py` command line utility
2+
======================================
3+
4+
.. automodule:: make_catalog
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/make_todo.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`make_todo.py` command line utility
2+
===================================
3+
4+
.. automodule:: make_todo
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/modules.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
.. include:: ../../photometry/README.rst
3+
4+
=========================================
5+
6+
Module Overview
7+
===============
8+
9+
.. toctree::
10+
:maxdepth: 4
11+
12+
photometry
13+
14+
15+
Command-line Utilities
16+
======================
17+
18+
.. toctree::
19+
:maxdepth: 4
20+
21+
make_catalog
22+
run_prepare_photometry
23+
make_todo
24+
run_tessphot
25+
run_tessphot_mpi
26+
run_ffimovie

‎docs/photometry.AperturePhotometry.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Aperture Photometry (``photometry.AperturePhotometry``)
2+
=======================================================
3+
4+
.. automodule:: photometry.AperturePhotometry.photometry
5+
6+
.. autoclass:: photometry.AperturePhotometry
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
K2P\ :sup:`2` (``photometry.AperturePhotometry.k2p2v2``)
12+
--------------------------------------------------------
13+
14+
.. automodule:: photometry.AperturePhotometry.k2p2v2
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:

‎docs/photometry.BasePhotometry.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
BasePhotometry (``photometry.BasePhotometry``)
2+
==============================================
3+
4+
.. autoclass:: photometry.BasePhotometry
5+
:undoc-members:
6+
:inherited-members:
7+
8+
Photometry Status (``photometry.STATUS``)
9+
=========================================
10+
11+
.. autoclass:: photometry.STATUS
12+
:undoc-members:
13+
:inherited-members:

‎docs/photometry.HaloPhotometry.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Halo Photometry (``photometry.HaloPhotometry``)
2+
===============================================
3+
4+
.. automodule:: photometry.halo.halo_photometry
5+
6+
.. autoclass:: photometry.HaloPhotometry
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/photometry.catalog.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Star Catalog (``photometry.catalog``)
2+
=====================================
3+
4+
.. automodule:: photometry.catalog
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/photometry.image_motion.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Image Movement Kernel (``photometry.ImageMovementKernel``)
2+
==========================================================
3+
4+
.. autoclass:: photometry.ImageMovementKernel
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/photometry.linpsf_photometry.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Linear PSF Photometry (``photometry.LinPSFPhotometry``)
2+
=======================================================
3+
4+
.. automodule:: photometry.linpsf_photometry
5+
6+
.. autoclass:: photometry.LinPSFPhotometry
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/photometry.plots.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Plotting Utilities (``photometry.plots``)
2+
=========================================
3+
4+
.. automodule:: photometry.plots
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/photometry.prepare.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Data Preparation (``photometry.prepare``)
2+
=========================================
3+
4+
.. automodule:: photometry.prepare
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Background estimation (``photometry.backgrounds``)
10+
--------------------------------------------------
11+
12+
.. automodule:: photometry.backgrounds
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:

‎docs/photometry.psf.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Point Spread Function (``photometry.psf``)
2+
==========================================
3+
4+
.. automodule:: photometry.psf
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:

‎docs/photometry.psf_photometry.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
PSF Photometry (``photometry.PSFPhotometry``)
2+
=============================================
3+
4+
.. automodule:: photometry.psf_photometry
5+
6+
.. autoclass:: photometry.PSFPhotometry
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
:inherited-members:

‎docs/photometry.quality.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Quality Flags (``photometry.quality``)
2+
======================================
3+
4+
.. automodule:: photometry.quality
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/photometry.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
TASOC Photometry (``photometry`` package)
2+
=========================================
3+
4+
Preparation functions
5+
---------------------
6+
7+
.. toctree::
8+
9+
photometry.catalog
10+
photometry.prepare
11+
photometry.todolist
12+
13+
14+
Photometric methods
15+
-------------------
16+
17+
.. toctree::
18+
19+
photometry.BasePhotometry
20+
photometry.AperturePhotometry
21+
photometry.HaloPhotometry
22+
photometry.psf_photometry
23+
photometry.linpsf_photometry
24+
25+
26+
Helper classes and utilities
27+
----------------------------
28+
29+
.. toctree::
30+
31+
photometry.psf
32+
photometry.plots
33+
photometry.image_motion
34+
photometry.quality
35+
photometry.taskmanager
36+
photometry.utilities
37+
38+
39+
Running the photometry (``tessphot``)
40+
-------------------------------------
41+
42+
.. automodule:: photometry.tessphot
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/photometry.taskmanager.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Task Manager (``photometry.TaskManager``)
2+
=========================================
3+
4+
.. autoclass:: photometry.TaskManager
5+
:undoc-members:
6+
:inherited-members:

‎docs/photometry.todolist.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
TODO-list generation (``photometry.todolist``)
2+
==============================================
3+
4+
.. automodule:: photometry.todolist
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/photometry.utilities.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Utilities (``photometry.utilities``)
2+
====================================
3+
4+
.. automodule:: photometry.utilities
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/run_ffimovie.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`run_ffimovie.py` command line utility
2+
======================================
3+
4+
.. automodule:: run_ffimovie
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/run_prepare_photometry.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`run_prepare_photometry.py` command line utility
2+
================================================
3+
4+
.. automodule:: run_prepare_photometry
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/run_tessphot.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`run_tessphot.py` command line utility
2+
======================================
3+
4+
.. automodule:: run_tessphot
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/run_tessphot_mpi.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`run_tessphot_mpi` command line utility
2+
=======================================
3+
4+
.. automodule:: run_tessphot_mpi
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)