Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
finam
Manage
Activity
Members
Labels
Plan
Issues
31
Issue boards
Milestones
Code
Merge requests
3
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FINAM
finam
Commits
324c79c3
Commit
324c79c3
authored
2 years ago
by
Sebastian Müller
🐈
Browse files
Options
Downloads
Patches
Plain Diff
docs: rework high level features and api page
parent
547c6e11
No related branches found
No related tags found
1 merge request
!114
Doc: Integrate FINAM book and update API doc
Pipeline
#122771
passed with stages
Stage: test
Stage: build
in 2 minutes and 51 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/source/api/index.rst
+1
-5
1 addition, 5 deletions
docs/source/api/index.rst
src/finam/__init__.py
+43
-37
43 additions, 37 deletions
src/finam/__init__.py
with
44 additions
and
42 deletions
docs/source/api/index.rst
+
1
−
5
View file @
324c79c3
...
...
@@ -3,16 +3,12 @@ API reference
=============
.. automodule:: finam
:noindex:
.. raw:: latex
\clearpage
.. toctree::
:hidden:
self
.. toctree::
:hidden:
:caption: Subpackages
...
...
This diff is collapsed.
Click to expand it.
src/finam/__init__.py
+
43
−
37
View file @
324c79c3
"""
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
(
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment