DOC(ARCH): +archi section, with diagram image

JRCSTU · Aug 25, 2019 · a0b02f8 · a0b02f8
1 parent 629e498
commit a0b02f8
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 9 deletions.
diff --git a/docs/_static/WLTP_architecture.png b/docs/_static/WLTP_architecture.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -139,6 +139,7 @@ def setup(app):
     "sphinx.ext.autosummary",
     "sphinx.ext.extlinks",
     "sphinx.ext.todo",
+    "sphinx.ext.autosectionlabel",
     "matplotlib.sphinxext.plot_directive",
 ]
 

diff --git a/wltp/cycler.py b/wltp/cycler.py
@@ -209,7 +209,7 @@ def add_class_phase_markers(
         :param cycle:
             assumes indexed by time
         :param wltc_parts:
-            must include edges (see :func:`~datamodel.get_class_parts_limits()`)
+            must include edges (see :func:`~.datamodel.get_class_parts_limits()`)
         """
         assert all(i is not None for i in (cycle, wltc_parts)), (
             "Null in inputs:",
@@ -255,7 +255,7 @@ def __init__(self, *velocities: Union[pd.Series, pd.DataFrame], **kwargs):
         Initialize :attr:`cycle` with the given velocities and acceleration of the last one.
 
         :param velocities:
-            *named* series, e.g. from :func:`~datamodel.get_class_v_cycle()`,
+            *named* series, e.g. from :func:`~.datamodel.get_class_v_cycle()`,
             all sharing the same time-index  The last one is assumed to be the
             "target" velocity for the rest of the cycle methods.
 
@@ -303,8 +303,8 @@ def add_wots(self, gwots: pd.DataFrame):
 
         :param gwots:
             a dataframe of wot columns indexed by a grid of rounded velocities,
-            as generated by :func:`~engine.interpolate_wot_on_v_grid2()`, and
-            augmented by `:func:`~engine.calc_p_avail_in_gwots()`.
+            as generated by :func:`~.engine.interpolate_wot_on_v_grid2()`, and
+            augmented by :func:`~.engine.calc_p_avail_in_gwots()`.
 
         """
         c = wio.pstep_factory.get().cycle

diff --git a/wltp/datamodel.py b/wltp/datamodel.py
@@ -6,7 +6,7 @@
 # You may not use this work except in compliance with the Licence.
 # You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl
 """
-Defines schema, defaults and validations for data consumed/produced by :class:`~wltp.experiment.Experiment`.
+Defines schema, defaults and validations for data consumed/produced by :class:`~.experiment.Experiment`.
 
 The datamodel-instance is managed by :class:`pandel.Pandel`.
 """

diff --git a/wltp/engine.py b/wltp/engine.py
@@ -455,7 +455,7 @@ def calc_fixed_n_min_drives(mdl: Mapping, n_idle: int, n_rated: int) -> NMinDriv
     Calculate minimum revolutions according to Annex 2-2.k.
 
     Assumes model has been validated, but
-    not yet called :func:`~datamodel.yield_n_min_errors()`.
+    not yet called :func:`~.datamodel.yield_n_min_errors()`.
 
     """
     # TODO: accept ARRAY `n_min_drive`

diff --git a/wltp/experiment.py b/wltp/experiment.py
@@ -45,7 +45,7 @@
 _GEARS_YES:  boolean (#gears X #cycle_steps)
     One row per gear having ``True`` wherever gear is possible for each step.
 
-.. Seealso:: :mod:`~datamodel` for in/out schemas
+.. Seealso:: :mod:`~,datamodel` for in/out schemas
 """
 
 import logging

diff --git a/wltp/vmax.py b/wltp/vmax.py
@@ -125,8 +125,8 @@ def calc_v_max(
     :param gwots:
         a dataframe containing (at least) `p_avail_stable` column, 
         indexed by a grid of rounded velocities,
-        as generated by :func:`~engine.interpolate_wot_on_v_grid2()`, and 
-        augmented by `:func:`~engine.calc_p_avail_in_gwots()` (in kW).
+        as generated by :func:`~.engine.interpolate_wot_on_v_grid2()`, and 
+        augmented by :func:`~.engine.calc_p_avail_in_gwots()` (in kW).
     :param p-resist:
     :return:
         a :class:`VMaxRec` namedtuple.