Skip to content

Commit

Permalink
Preserve Python API reference heading hierarchy
Browse files Browse the repository at this point in the history
There can only be one "Python API reference" section in a module
homepage, and all Python APIs need to be in it. This commit accommodates
the subsectioning within the Python API reference section. Most likely
those subsection will need to be turned into decorative rubric elements
so that the heading typography isn't but off balance; but that's for
another day.
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent 4832290 commit 6ca3814
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions doc/lsst.daf.butler/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,50 @@ Python API reference
====================

.. automodapi:: lsst.daf.butler
:no-main-docstr:

Example Datastores
==================
Example datastores
------------------

.. automodapi:: lsst.daf.butler.datastores.posixDatastore
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.datastores.inMemoryDatastore
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.datastores.chainedDatastore
:no-main-docstr:
:headings: ^"

Example Registries
==================
Example registries
------------------

.. automodapi:: lsst.daf.butler.registries.sqlRegistry
:no-main-docstr:
:headings: ^"

Example Formatters
==================
Example formatters
------------------

.. automodapi:: lsst.daf.butler.formatters.fileFormatter
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.jsonFormatter
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.yamlFormatter
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.pickleFormatter
:no-main-docstr:
:headings: ^"

Support API
===========
-----------

.. automodapi:: lsst.daf.butler.core.safeFileIo
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.core.utils
:no-main-docstr:
:headings: ^"

0 comments on commit 6ca3814

Please sign in to comment.