Skip to content

Add api ref page to docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nvaytet merged 1 commit into from
Apr 19, 2023
Merged

Add api ref page to docs #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. currentmodule:: tof

*************
API Reference
*************

.. autosummary::
:toctree: generated

Chopper
Detector
Model
Pulse
units
6 changes: 6 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ You can install from ``pip`` using

user-guide

.. toctree::
:maxdepth: 2
:hidden:

api

.. toctree::
:hidden:

Expand Down