Update docs to follow template

- Drop the package documentation directory - Update individual modules with boilerplate
lsst · Feb 8, 2019 · 9901ef2 · 9901ef2
1 parent 81b2eb9
commit 9901ef2
Show file tree

Hide file tree

Showing 13 changed files with 106 additions and 87 deletions.
diff --git a/doc/afw/index.rst b/doc/afw/index.rst
diff --git a/doc/lsst.afw.cameraGeom/index.rst b/doc/lsst.afw.cameraGeom/index.rst
@@ -1,20 +1,32 @@
+.. py:currentmodule:: lsst.afw.cameraGeom
+
 .. _lsst.afw.cameraGeom:
 
 ###################
 lsst.afw.cameraGeom
 ###################
 
-The cameraGeom package describes the geometry of an imaging camera.
+The ``lsst.afw.cameraGeom`` module describes the geometry of an imaging camera.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.cameraGeom-using:
 
 Using lsst.afw.cameraGeom
 =========================
 
 .. toctree::
    :maxdepth: 1
 
-   cameraGeom.rst
+   cameraGeom
+
+.. _lsst.afw.cameraGeom-contributing:
+
+Contributing
+============
+
+``lsst.afw.cameraGeom`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
+
+.. _lsst.afw.cameraGeom-pyapi:
 
 Python API reference
 ====================

diff --git a/doc/lsst.afw.coord/index.rst b/doc/lsst.afw.coord/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.coord
+
 .. _lsst.afw.coord:
 
 ##############
@@ -6,7 +8,13 @@ lsst.afw.coord
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.coord-contributing:
+
+Contributing
+============
+
+``lsst.afw.coord`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
 
 Python API reference
 ====================

diff --git a/doc/lsst.afw.detection/index.rst b/doc/lsst.afw.detection/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.detection
+
 .. _lsst.afw.detection:
 
 ##################
@@ -16,12 +18,8 @@ Using lsst.afw.detection
 
    Footprint
 
-.. toctree::
-    : maxdepth: 1
-
-    Footprint.rst
-
-Python API reference
-====================
+Contributing
+============
 
-.. .. automodapi:: lsst.afw.detection
+``lsst.afw.detection`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
diff --git a/doc/lsst.afw.display/index.rst b/doc/lsst.afw.display/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.display
+
 .. _lsst.afw.display:
 
 ################
@@ -6,11 +8,18 @@ lsst.afw.display
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.display-contributing:
+
+Contributing
+============
+
+``lsst.afw.display`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
+
+.. _lsst.afw.display-pyapi:
 
 Python API reference
 ====================
 
 .. automodapi:: lsst.afw.display
    :no-inheritance-diagram:
-
diff --git a/doc/lsst.afw.fits/index.rst b/doc/lsst.afw.fits/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.fits
+
 .. _lsst.afw.fits:
 
 #############
@@ -6,9 +8,10 @@ lsst.afw.fits
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.fits-contributing:
 
-Python API reference
-====================
+Contributing
+============
 
-.. .. automodapi:: lsst.afw.fits
+``lsst.afw.fits`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
diff --git a/doc/lsst.afw.formatters/index.rst b/doc/lsst.afw.formatters/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.formatters
+
 .. _lsst.afw.formatters:
 
 ###################
@@ -6,7 +8,15 @@ lsst.afw.formatters
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.formatters-contributing:
+
+Contributing
+============
+
+``lsst.afw.formatters`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
+
+.. _lsst.afw.formatters-pyapi:
 
 Python API reference
 ====================

diff --git a/doc/lsst.afw.geom/index.rst b/doc/lsst.afw.geom/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.geom
+
 .. _lsst.afw.geom:
 
 #############
@@ -6,15 +8,25 @@ lsst.afw.geom
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-Using afw.geom
-==============
+.. _lsst.afw.geom-using:
 
-.. Add subsections with toctree to individual topic pages.
+Using lsst.afw.geom
+===================
 
 .. toctree::
    :maxdepth: 1
 
-   SpanSet.rst
+   SpanSet
+
+.. _lsst.afw.geom-contributing:
+
+Contributing
+============
+
+``lsst.afw.geom`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
+
+.. _lsst.afw.geom-pyapi:
 
 Python API reference
 ====================

diff --git a/doc/lsst.afw.image/index.rst b/doc/lsst.afw.image/index.rst
@@ -1,4 +1,4 @@
-.. :py:currentmodule:: lsst.afw.image
+.. py:currentmodule:: lsst.afw.image
 
 .. _lsst.afw.image:
 
@@ -19,9 +19,10 @@ Using lsst.afw.image
    indexing-conventions
    exposure-fits-metadata
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.image-contributing:
 
-Python API reference
-====================
+Contributing
+============
 
-.. .. automodapi:: lsst.afw.image
+``lsst.afw.image`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
diff --git a/doc/lsst.afw.math/index.rst b/doc/lsst.afw.math/index.rst
@@ -6,8 +6,7 @@
 lsst.afw.math
 #############
 
-Mathematical functions such as convolution and image statistics
-
+``lsst.afw.math`` provides mathematical functions such as convolution and image statistics.
 Key features:
 
 * Function objects `FunctionF` and `FunctionD`
@@ -37,14 +36,16 @@ Using lsst.afw.math
 Contributing
 ============
 
-``lsst.afw`` is developed at https://github.com/lsst/afw.
+``lsst.afw.math`` is developed at https://github.com/lsst/afw.
 You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
 
 .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
 
 .. .. toctree::
 ..    :maxdepth: 1
 
+.. _lsst.afw.math-pyapi:
+
 Python API reference
 ====================
 

diff --git a/doc/lsst.afw.multiband/index.rst b/doc/lsst.afw.multiband/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.multiband
+
 .. _lsst.afw.multiband:
 
 ##################
@@ -6,17 +8,22 @@ lsst.afw.multiband
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-Using afw.multiband
-===================
+.. _lsst.afw.multiband-using:
+
+Using lsst.afw.multiband
+========================
 
 .. Add subsections with toctree to individual topic pages.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+
+   multiband
 
-   multiband.rst
+.. _lsst.afw.multiband-contributing:
 
-Python API reference
-====================
+Contributing
+============
 
-.. .. automodapi:: lsst.afw.multiband
+``lsst.afw.multiband`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
diff --git a/doc/lsst.afw.table/index.rst b/doc/lsst.afw.table/index.rst
@@ -1,3 +1,5 @@
+.. py:currentmodule:: lsst.afw.table
+
 .. _lsst.afw.table:
 
 ##############
@@ -6,9 +8,10 @@ lsst.afw.table
 
 .. Paragraph that describes what this Python module does and links to related modules and frameworks.
 
-.. Add subsections with toctree to individual topic pages.
+.. _lsst.afw.table-contributing:
 
-Python API reference
-====================
+Contributing
+============
 
-.. .. automodapi:: lsst.afw.table
+``lsst.afw.table`` is developed at https://github.com/lsst/afw.
+You can find Jira issues for this module under the `afw <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20afw>`_ component.
diff --git a/doc/manifest.yaml b/doc/manifest.yaml
@@ -1,9 +1,5 @@
 # Documentation manifest.
 
-# Name of this package
-# Also the name of the package documentation subdirectory.
-package: "afw"
-
 # List of names of Python modules in this package.
 # For each module there is a corresponding module doc subdirectory.
 modules:
@@ -17,8 +13,3 @@ modules:
   - "lsst.afw.image"
   - "lsst.afw.math"
   - "lsst.afw.table"
-
-# Name of the static content directories (subdirectories of `_static`).
-# Static content directories are usually named after the package.
-statics:
-  - "_static/afw"