Skip to content
Snippets Groups Projects
Commit 324c79c3 authored by Sebastian Müller's avatar Sebastian Müller 🐈
Browse files

docs: rework high level features and api page

parent 547c6e11
No related branches found
No related tags found
1 merge request!114Doc: Integrate FINAM book and update API doc
Pipeline #122771 passed with stages
in 2 minutes and 51 seconds
......@@ -3,16 +3,12 @@ API reference
=============
.. automodule:: finam
:noindex:
.. raw:: latex
\clearpage
.. toctree::
:hidden:
self
.. toctree::
:hidden:
:caption: Subpackages
......
"""
The FINAM model coupling framework.
Subpackages
===========
.. toctree::
:hidden:
.. autosummary::
adapters
data
modules
sdk
tools
interfaces
schedule
self
Schedule
========
.. currentmodule:: finam.schedule
.. autosummary::
:toctree: generated
:caption: Schedule
Composition
Interfaces
==========
.. currentmodule:: finam.interfaces
.. autosummary::
ComponentStatus
FinamLogError
FinamMetaDataError
FinamNoDataError
FinamStatusError
FinamTimeError
Loggable
NoBranchAdapter
Software development kit
========================
.. currentmodule:: finam.sdk
.. autosummary::
:toctree: generated
:caption: Software development kit
Adapter
CallbackInput
......@@ -57,9 +33,9 @@ Software development kit
Grids
=====
.. currentmodule:: finam.data
.. autosummary::
:toctree: generated
:caption: Grids
EsriGrid
NoGrid
......@@ -71,9 +47,9 @@ Grids
Grid tools
==========
.. currentmodule:: finam.data
.. autosummary::
:toctree: generated
:caption: Grid tools
CellType
Location
......@@ -81,13 +57,43 @@ Grid tools
Data tools
==========
.. currentmodule:: finam.data
.. autosummary::
:toctree: generated
:caption: Data tools
UNITS
FinamDataError
Info
Interfaces
==========
.. autosummary::
:toctree: generated
:caption: Interfaces
ComponentStatus
FinamLogError
FinamMetaDataError
FinamNoDataError
FinamStatusError
FinamTimeError
Loggable
NoBranchAdapter
Subpackages
===========
.. autosummary::
adapters
data
modules
sdk
tools
interfaces
schedule
"""
from . import adapters, data, interfaces, modules, schedule, sdk, tools
from .data.grid_spec import (
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment