-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Doxygen products | ||
html | ||
xml | ||
*.tag | ||
*.inc | ||
doxygen.conf | ||
|
||
# Sphinx products | ||
_build | ||
py-api |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
"""Sphinx configuration file for an LSST stack package. | ||
This configuration only affects single-package Sphinx documenation builds. | ||
""" | ||
|
||
from documenteer.sphinxconfig.stackconf import build_package_configs | ||
import lsst.meas.deblender | ||
|
||
|
||
_g = globals() | ||
_g.update(build_package_configs( | ||
project_name='meas_deblender', | ||
version=lsst.meas.deblender.version.__version__)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
#################################### | ||
meas_deblender documentation preview | ||
#################################### | ||
|
||
.. This page is for local development only. It isn't published to pipelines.lsst.io. | ||
.. Link the index pages of package and module documentation directions (listed in manifest.yaml). | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
meas_deblender/index | ||
lsst.meas.deblender/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.. _lsst.meas.deblender: | ||
|
||
################### | ||
lsst.meas.deblender | ||
################### | ||
|
||
.. Paragraph that describes what this Python module does and links to related modules and frameworks. | ||
.. Add subsections with toctree to individual topic pages. | ||
Python API reference | ||
==================== | ||
|
||
.. .. automodapi:: lsst.meas.deblender |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Documentation manifest. | ||
|
||
# Name of this package | ||
# Also the name of the package documentation subdirectory. | ||
package: "meas_deblender" | ||
|
||
# List of names of Python modules in this package. | ||
# For each module there is a corresponding module doc subdirectory. | ||
modules: | ||
- "lsst.meas.deblender" | ||
|
||
# Name of the static content directories (subdirectories of `_static`). | ||
# Static content directories are usually named after the package. | ||
statics: | ||
- "_static/meas_deblender" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.. _meas_deblender-package: | ||
|
||
.. Title is the EUPS package name | ||
############## | ||
meas_deblender | ||
############## | ||
|
||
.. Add a sentence/short paragraph describing what the package is for. | ||
The ``meas_deblender`` package provides source deblending algorithms for LSST DM. | ||
|
||
Project info | ||
============ | ||
|
||
Repository | ||
https://github.com/lsst.meas.deblender | ||
|
||
JIRA component | ||
`meas_deblender <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20meas_deblender>`_ | ||
|
||
Modules | ||
======= | ||
|
||
.. Link to Python module landing pages (same as in manifest.yaml) | ||
- :ref:`lsst.meas.deblender <lsst.meas.deblender>` |