Skip to content

Commit

Permalink
DOC: Use a subsection in API docs per dataset
Browse files Browse the repository at this point in the history
  • Loading branch information
scottclowe committed Dec 7, 2024
1 parent ff12312 commit 9188eaa
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
API Reference
=============

BIOSCAN-1M Dataset
------------------

.. autoclass:: bioscan_dataset.BIOSCAN1M
:members:
:show-inheritance:

.. autofunction:: bioscan_dataset.load_bioscan1m_metadata

BIOSCAN-5M Dataset
------------------

.. autoclass:: bioscan_dataset.BIOSCAN5M
:members:
:show-inheritance:

.. autofunction:: bioscan_dataset.load_bioscan1m_metadata

.. autofunction:: bioscan_dataset.load_bioscan5m_metadata

0 comments on commit 9188eaa

Please sign in to comment.