Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-25416: Fix documentation build from renamed formatters #315

Merged
merged 4 commits into from
Jun 13, 2020
Merged

DM-25416: Fix documentation build from renamed formatters #315

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b7c5ff
Correct path to renamed formatters in docs
timj Jun 13, 2020
11dfba1
Add misssing formatters to Sphinx
timj Jun 13, 2020
abcd8e8
Add S3Datastore to docs
timj Jun 13, 2020
ac2bc11
Alphabetize datastore and formatter entries
timj Jun 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 16 additions & 4 deletions doc/lsst.daf.butler/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,32 @@ Example datastores
.. automodapi:: lsst.daf.butler.datastores.chainedDatastore
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.datastores.s3Datastore
:no-main-docstr:
:headings: ^"

Example formatters
------------------

.. automodapi:: lsst.daf.butler.formatters.fileFormatter
.. automodapi:: lsst.daf.butler.formatters.file
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.json
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.yaml
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.pickle
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.jsonFormatter
.. automodapi:: lsst.daf.butler.formatters.parquet
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.yamlFormatter
.. automodapi:: lsst.daf.butler.formatters.matplotlib
:no-main-docstr:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.pickleFormatter
.. automodapi:: lsst.daf.butler.formatters.pexConfig
:no-main-docstr:
:headings: ^"

Expand Down