-
Notifications
You must be signed in to change notification settings - Fork 10
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 match templates
- Remove unneeded doc/ directory - Update module homepage to match templates
- Loading branch information
1 parent
c5c6eb3
commit e0dd313
Showing
4 changed files
with
15 additions
and
41 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 @@ obs_base documentation preview | |
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
obs_base/index | ||
lsst.obs.base/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,27 @@ | ||
.. py:currentmodule:: lsst.obs.base | ||
.. _lsst.obs.base: | ||
|
||
############# | ||
lsst.obs.base | ||
############# | ||
|
||
.. Paragraph that describes what this Python module does and links to related modules and frameworks. | ||
The ``lsst.obs.base`` module provides the framework and common API for telescope/camera specific "obs" packages. | ||
New cameras will derive from the classes defined here. | ||
`lsst.obs.base.tests` provides the tests that all "obs" packages should pass. | ||
|
||
.. _lsst.obs.base-contributing: | ||
|
||
Contributing | ||
============ | ||
|
||
``lsst.obs.base`` is developed at https://github.com/lsst/obs_base. | ||
You can find Jira issues for this module under the `obs_base <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20obs_base>`_ component. | ||
|
||
.. Add subsections with toctree to individual topic pages. | ||
.. _lsst.obs.base-pyapi: | ||
|
||
Python API reference | ||
==================== | ||
|
||
.. automodapi:: lsst.obs.base | ||
: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: "obs_base" | ||
|
||
# List of names of Python modules in this package. | ||
# For each module there is a corresponding module doc subdirectory. | ||
modules: | ||
- "lsst.obs.base" | ||
|
||
# Name of the static content directories (subdirectories of `_static`). | ||
# Static content directories are usually named after the package. | ||
# statics: | ||
# - "_static/obs_base" |
This file was deleted.
Oops, something went wrong.