Skip to content

Commit

Permalink
Include new query system in doc builds.
Browse files Browse the repository at this point in the history
For now these are in the "internal" section of the docs; the direct
query driver always will be.
  • Loading branch information
TallJimbo committed Mar 28, 2024
1 parent e665a24 commit ec40983
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions doc/lsst.daf.butler/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,31 @@ Datastore utilities
:headings: ^"
:skip: Datastore

Queries
-------

.. This section should move out of the "Middleware-Internal API" section when.
we release the new query system by renaming Butler._query to Butler.query.
.. automodapi:: lsst.daf.butler.queries
:no-main-docstr:
:no-inherited-members:
:headings: ^"

.. automodapi:: lsst.daf.butler.queries.tree
:no-main-docstr:
:no-inherited-members:
:headings: ^"
:skip: InvalidQueryError

Direct butler query driver
---------------------------

.. automodapi:: lsst.daf.butler.direct_query_driver
:no-main-docstr:
:no-inherited-members:
:headings: ^"

Registry utilities and interfaces
---------------------------------

Expand Down

0 comments on commit ec40983

Please sign in to comment.