Skip to content

Commit

Permalink
Skip ButlerURI in toc
Browse files Browse the repository at this point in the history
ButlerURI is an alias for ResourcePath and this confusess sphinx,
especially when building pipelines.lsst.io.
Simplest to remove the toc entry completely.

A class stub is given although this does not get linked.
  • Loading branch information
timj committed Dec 7, 2021
1 parent 0818112 commit e3fa06e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/lsst.daf.butler/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ Python API reference

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

.. py:class:: lsst.daf.butler.ButlerURI(uri)
``ButlerURI`` implementation. Exists for backwards compatibility.
New code should use `lsst.resources.ResourcePath`.

.. automodapi:: lsst.daf.butler.registry
:no-main-docstr:
Expand Down

0 comments on commit e3fa06e

Please sign in to comment.