-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update doc directory to follow current templates
- Remove unneeded package doc directory - Update module homepage to match current templates
- Loading branch information
1 parent
88ed2d8
commit 02f33f7
Showing
4 changed files
with
13 additions
and
39 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 |
---|---|---|
|
@@ -9,5 +9,4 @@ pipe_drivers documentation preview | |
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
pipe_drivers/index | ||
lsst.pipe.drivers/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 |
---|---|---|
@@ -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: |
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 |
---|---|---|
@@ -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" |
This file was deleted.
Oops, something went wrong.