Skip to content

Commit

Permalink
Update doc/ directory for sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
parejkoj committed Mar 30, 2018
1 parent 8b7e855 commit e407e10
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/.gitignore
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
13 changes: 13 additions & 0 deletions doc/conf.py
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__))
13 changes: 13 additions & 0 deletions doc/index.rst
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
14 changes: 14 additions & 0 deletions doc/lsst.meas.deblender/index.rst
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
15 changes: 15 additions & 0 deletions doc/manifest.yaml
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"
27 changes: 27 additions & 0 deletions doc/meas_deblender/index.rst
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>`

0 comments on commit e407e10

Please sign in to comment.