Skip to content

Commit

Permalink
Fix Sphinx warnings by ignoring inherited members.
Browse files Browse the repository at this point in the history
This keeps our doc build from trying to parse upstream docstrings that
may not be numpydoc.  I'm sure we don't have to use it in all of our
modules, but I don't have much of an opinion about whether including
inherited members is generally useful, so consistency wins.
  • Loading branch information
TallJimbo committed Jan 31, 2024
1 parent 7161411 commit 27dec8f
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions doc/lsst.daf.butler/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,48 +101,59 @@ Python API reference

.. automodapi:: lsst.daf.butler
:no-main-docstr:
:no-inherited-members:
:skip: RegistryConfig

Example datastores
------------------

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

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

.. automodapi:: lsst.daf.butler.formatters.file
:no-main-docstr:
:no-inherited-members:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.json
:no-main-docstr:
:no-inherited-members:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.matplotlib
:no-main-docstr:
:no-inherited-members:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.parquet
:no-main-docstr:
:no-inherited-members:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.pickle
:no-main-docstr:
:no-inherited-members:
:headings: ^"
.. automodapi:: lsst.daf.butler.formatters.yaml
:no-main-docstr:
:no-inherited-members:
:headings: ^"

Test utilities
--------------

.. automodapi:: lsst.daf.butler.tests
:no-main-docstr:
:no-inherited-members:
:headings: ^"
:no-inheritance-diagram:

Expand All @@ -158,6 +169,7 @@ Datastore utilities

.. automodapi:: lsst.daf.butler.datastore
:no-main-docstr:
:no-inherited-members:
:headings: ^"
:skip: Datastore

Expand All @@ -166,91 +178,111 @@ Registry utilities and interfaces

.. automodapi:: lsst.daf.butler.registry
:no-main-docstr:
:no-inherited-members:
:headings: ^"
:skip: Registry
:skip: CollectionType

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

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

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

Database backends
-----------------

.. automodapi:: lsst.daf.butler.registry.databases.sqlite
:no-main-docstr:
:no-inherited-members:
:headings: ^"

.. automodapi:: lsst.daf.butler.registry.databases.postgresql
:no-main-docstr:
:no-inherited-members:
:headings: ^"

General utilities
-----------------

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

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

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

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

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

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

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

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

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

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

.. automodapi:: lsst.daf.butler.repo_relocation
:no-main-docstr:
:headings: ^"
:no-inherited-members:
:include-all-objects:

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

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

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

Command-Line Interface Utilities
Expand Down

0 comments on commit 27dec8f

Please sign in to comment.