From b4e7ec4c478068d83b95f4bf6d291e02b7459b14 Mon Sep 17 00:00:00 2001
From: Martin Lange <martin.lange@ufz.de>
Date: Sat, 22 Oct 2022 02:26:15 +0200
Subject: [PATCH] get rid of duplicate refs
---
src/finam/__init__.py | 18 +++++++++++++++---
src/finam/data/__init__.py | 22 +++++++++++-----------
src/finam/interfaces.py | 21 +++++++++++++--------
src/finam/schedule.py | 2 +-
src/finam/sdk/__init__.py | 14 +++++++-------
5 files changed, 47 insertions(+), 30 deletions(-)
diff --git a/src/finam/__init__.py b/src/finam/__init__.py
index 1aca8579..6949911a 100644
--- a/src/finam/__init__.py
+++ b/src/finam/__init__.py
@@ -79,6 +79,11 @@ Interfaces
FinamStatusError
FinamTimeError
Loggable
+ IComponent
+ ITimeComponent
+ IAdapter
+ IInput
+ IOutput
NoBranchAdapter
Subpackages
@@ -91,10 +96,7 @@ Subpackages
adapters
data
modules
- sdk
tools
- interfaces
- schedule
"""
from . import adapters, data, interfaces, modules, schedule, sdk, tools
@@ -115,6 +117,11 @@ from .interfaces import (
FinamNoDataError,
FinamStatusError,
FinamTimeError,
+ IAdapter,
+ IComponent,
+ IInput,
+ IOutput,
+ ITimeComponent,
Loggable,
NoBranchAdapter,
)
@@ -139,6 +146,11 @@ except ModuleNotFoundError: # pragma: no cover
__all__ = ["__version__"]
__all__ += ["adapters", "data", "interfaces", "modules", "schedule", "sdk", "tools"]
__all__ += [
+ "IComponent",
+ "ITimeComponent",
+ "IAdapter",
+ "IInput",
+ "IOutput",
"ComponentStatus",
"FinamLogError",
"FinamMetaDataError",
diff --git a/src/finam/data/__init__.py b/src/finam/data/__init__.py
index f29169f9..9b39e159 100644
--- a/src/finam/data/__init__.py
+++ b/src/finam/data/__init__.py
@@ -7,12 +7,12 @@ Grids
.. autosummary::
:toctree: generated
- EsriGrid
- NoGrid
- RectilinearGrid
- UniformGrid
- UnstructuredGrid
- UnstructuredPoints
+ :noindex: EsriGrid
+ :noindex: NoGrid
+ :noindex: RectilinearGrid
+ :noindex: UniformGrid
+ :noindex: UnstructuredGrid
+ :noindex: UnstructuredPoints
Grid tools
@@ -25,8 +25,8 @@ Grid tools
check_axes_monotonicity
check_axes_uniformity
check_uniformity
- CellType
- Location
+ :noindex: CellType
+ :noindex: Location
GridBase
Grid
StructuredGrid
@@ -37,9 +37,9 @@ Data tools
.. autosummary::
:toctree: generated
- UNITS
- FinamDataError
- Info
+ :noindex: UNITS
+ :noindex: FinamDataError
+ :noindex: Info
assert_type
check
check_quantified
diff --git a/src/finam/interfaces.py b/src/finam/interfaces.py
index 26af92f5..0eec2d56 100644
--- a/src/finam/interfaces.py
+++ b/src/finam/interfaces.py
@@ -7,14 +7,19 @@ Interfaces
.. autosummary::
:toctree: generated
- ComponentStatus
- FinamLogError
- FinamMetaDataError
- FinamNoDataError
- FinamStatusError
- FinamTimeError
- Loggable
- NoBranchAdapter
+ :noindex: IComponent
+ :noindex: ITimeComponent
+ :noindex: IAdapter
+ :noindex: IInput
+ :noindex: IOutput
+ :noindex: ComponentStatus
+ :noindex: FinamLogError
+ :noindex: FinamMetaDataError
+ :noindex: FinamNoDataError
+ :noindex: FinamStatusError
+ :noindex: FinamTimeError
+ :noindex: Loggable
+ :noindex: NoBranchAdapter
"""
import logging
from abc import ABC, abstractmethod
diff --git a/src/finam/schedule.py b/src/finam/schedule.py
index 0555632a..e52c137d 100644
--- a/src/finam/schedule.py
+++ b/src/finam/schedule.py
@@ -7,7 +7,7 @@ Composition
.. autosummary::
:toctree: generated
- Composition
+ :noindex: Composition
"""
import logging
import sys
diff --git a/src/finam/sdk/__init__.py b/src/finam/sdk/__init__.py
index 95a47154..75b9e9c6 100644
--- a/src/finam/sdk/__init__.py
+++ b/src/finam/sdk/__init__.py
@@ -7,13 +7,13 @@ Software development kit
.. autosummary::
:toctree: generated
- Adapter
- Component
- TimeComponent
- CallbackInput
- CallbackOutput
- Input
- Output
+ :noindex: Adapter
+ :noindex: Component
+ :noindex: TimeComponent
+ :noindex: CallbackInput
+ :noindex: CallbackOutput
+ :noindex: Input
+ :noindex: Output
"""
from .adapter import Adapter
from .component import Component, TimeComponent
--
GitLab