Skip to content

Commit

Permalink
Update doc/ directory to match templates
Browse files Browse the repository at this point in the history
- Remove unneeded doc/ directory
- Update module homepage to match templates
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent c5c6eb3 commit e0dd313
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 41 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 @@ obs_base documentation preview
.. toctree::
:maxdepth: 1

obs_base/index
lsst.obs.base/index
17 changes: 15 additions & 2 deletions doc/lsst.obs.base/index.rst
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:
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: "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"
29 changes: 0 additions & 29 deletions doc/obs_base/index.rst

This file was deleted.

0 comments on commit e0dd313

Please sign in to comment.