Skip to content

Commit

Permalink
Update doc directory to match current templates
Browse files Browse the repository at this point in the history
- Remove unneeded package doc directory
- Update module homepage to match the current template
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent 860de37 commit b12984d
Show file tree
Hide file tree
Showing 4 changed files with 14 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 @@ utils documentation preview
.. toctree::
:maxdepth: 1

utils/index
lsst.utils/index
16 changes: 14 additions & 2 deletions doc/lsst.utils/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
.. py:currentmodule:: lsst.utils
.. _lsst.utils:

##########
lsst.utils
##########

.. Paragraph that describes what this Python module does and links to related modules and frameworks.
The ``lsst.utils`` module provides common code for tests, interfacing between C++ and Python, and debugging.

.. _lsst.utils-contributing:

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

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

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

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

.. automodapi:: lsst.utils
:no-main-docstr:
.. automodapi:: lsst.utils.tests
: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: "utils"

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

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

This file was deleted.

0 comments on commit b12984d

Please sign in to comment.