Skip to content

Commit

Permalink
Update doc/ directory to match template
Browse files Browse the repository at this point in the history
- Remove unneeded package doc directory
- Update module homepage to match template
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent e9f07e0 commit 9993640
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 42 deletions.
1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ jointcal documentation preview
.. toctree::
:maxdepth: 1

jointcal/index
lsst.jointcal/index
30 changes: 0 additions & 30 deletions doc/jointcal/index.rst

This file was deleted.

17 changes: 16 additions & 1 deletion doc/lsst.jointcal/index.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
.. py:currentmodule:: lsst.jointcal
.. _lsst.jointcal:

#############
lsst.jointcal
#############

.. Paragraph that describes what this Python module does and links to related modules and frameworks.
The ``lsst.jointcal`` module simultaneously optimizes the astrometric and photometric calibrations of a set of astronomical images.

.. Add subsections with toctree to individual topic pages.
.. _lsst.jointcal-contributing:

Contributing
============

``lsst.jointcal`` is developed at https://github.com/lsst/jointcal.
You can find Jira issues for this module under the `jointcal <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20jointcal>`_ component.

.. _lsst.jointcal-pyapi:

Python API reference
====================

.. automodapi:: lsst.jointcal
:no-main-docstr:
.. automodapi:: lsst.jointcal.dataIds
:no-main-docstr:
.. automodapi:: lsst.jointcal.utils
:no-main-docstr:
11 changes: 1 addition & 10 deletions doc/manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
# Documentation manifest.

# Name of this package
# Also the name of the package documentation subdirectory.
package: "jointcal"

#
# List of names of Python modules in this package.
# For each module there is a corresponding module doc subdirectory.
modules:
- "lsst.jointcal"

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
# statics:
# - "_static/jointcal"

0 comments on commit 9993640

Please sign in to comment.