Skip to content

Commit

Permalink
Merge pull request #104 from ManuelHu/docs-fixes
Browse files Browse the repository at this point in the history
docs: fix hist link, hide some useless private members
  • Loading branch information
gipert authored Aug 14, 2024
2 parents 25f43d1 + 7e2c9ee commit fcf0fe6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"pandas": ("https://pandas.pydata.org/docs", None),
"h5py": ("https://docs.h5py.org/en/stable", None),
"pint": ("https://pint.readthedocs.io/en/stable", None),
"hist": ("https://hist.readthedocs.io/en/latest", None),
"dspeed": ("https://dspeed.readthedocs.io/en/stable", None),
"daq2lh5": ("https://legend-daq2lh5.readthedocs.io/en/stable", None),
} # add new intersphinx mappings here
Expand All @@ -80,3 +81,14 @@
.. _nbsphinx: https://nbsphinx.readthedocs.io/
.. _Jupyter: https://jupyter.org/
"""


# Skip members that are created by the ABC metaclass.
def maybe_skip_member(app, what, name, obj, skip, options): # noqa: ARG001
if what == "class" and name == "_abc_impl":
return True
return skip


def setup(app):
app.connect("autodoc-skip-member", maybe_skip_member)
2 changes: 1 addition & 1 deletion docs/source/notebooks/LH5Files.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@
"id": "40",
"metadata": {},
"source": [
"Some types also support other specialized python libraries. For example, the `Histogram` [[docs]](https://legend-pydataobj.readthedocs.io/en/stable/api/lgdo.types.html#lgdo.types.histogram.Histogram.view_as) type allows us to easily show the data using the [`hist` package](https://hist.readthedocs.io/en/latest/):"
"Some types also support other specialized python libraries. For example, the `Histogram` [[docs]](https://legend-pydataobj.readthedocs.io/en/stable/api/lgdo.types.html#lgdo.types.histogram.Histogram.view_as) type allows us to easily show the data using the [hist package](https://hist.readthedocs.io/en/latest/):"
]
},
{
Expand Down

0 comments on commit fcf0fe6

Please sign in to comment.