Skip to content

Commit

Permalink
Fix up docs to work for data-objects
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Apr 18, 2020
1 parent 477e702 commit ed4ab83
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
7 changes: 7 additions & 0 deletions doc/_templates/data_object.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}

.. include:: {{fullname}}.examples
4 changes: 3 additions & 1 deletion doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,11 @@ Model Information

Objects to store settings, metadata and results for FOOOF models.

.. currentmodule:: fooof.data.data
.. currentmodule:: fooof.data

.. autosummary::
:toctree: generated/
:template: data_object.rst

FOOOFSettings
FOOOFMetaData
Expand All @@ -93,6 +94,7 @@ Object to store information about simulated data.

.. autosummary::
:toctree: generated/
:template: data_object.rst

SimParams

Expand Down

0 comments on commit ed4ab83

Please sign in to comment.