Skip to content

Commit

Permalink
Update doc directory to follow current templates
Browse files Browse the repository at this point in the history
- Remove unneeded package doc directory
- Update module homepage to match current templates
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent 88ed2d8 commit 02f33f7
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 39 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 @@ pipe_drivers documentation preview
.. toctree::
:maxdepth: 1

pipe_drivers/index
lsst.pipe.drivers/index
15 changes: 13 additions & 2 deletions doc/lsst.pipe.drivers/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
.. py:currentmodule:: lsst.pipe.drivers
.. _lsst.pipe.drivers:

#################
lsst.pipe.drivers
#################

.. Paragraph that describes what this Python module does and links to related modules and frameworks.
The ``lsst.pipe.drivers`` module provides high-level task execution and coordination scripts to allow task parallelization.

.. _lsst.pipe.drivers-contributing:

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

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

.. Add subsections with toctree to individual topic pages.
.. _lsst.pipe.drivers-pyapi:

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

.. automodapi:: lsst.pipe.drivers
:no-main-docstr:
9 changes: 0 additions & 9 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: "pipe_drivers"

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

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
statics:
- "_static/pipe_drivers"
27 changes: 0 additions & 27 deletions doc/pipe_drivers/index.rst

This file was deleted.

0 comments on commit 02f33f7

Please sign in to comment.