Merge branch 'point-to-sources' into 'main'

Point to sources in book

See merge request !204

docs/source/finam-book/development/adapters.rst

@@ -10,6 +10,9 @@ We will build up the adapters step by step, accompanied by some test code.
 
 It is assumed that you have FINAM :doc:`installed <../usage/installation>`, as well as :mod:`pytest`.
 
+For adapter implementation examples, browse the source code of the included adapters in module :mod:`.adapters`.
+The source code of each API entry is linked in it's upper right corner under ``[source]``.
+
 Set up a Python project
 -----------------------
 

docs/source/finam-book/development/components.rst

@@ -12,7 +12,11 @@ Finally, it will have two input slots and one output slot, and will calculate th
 The component will have internal time stepping, like a simulation model would have.
 For implementing components without internal time, see chapter :doc:`./special_components`.
 
-It is assumed that you have FINAM :doc:`../usage/installation`, as well as :mod:`pytest`.
+It is assumed that you have FINAM :doc:`installed <../usage/installation>`, as well as :mod:`pytest`.
+
+For component implementation examples, see the `FINAM Examples repository <https://git.ufz.de/FINAM/finam-examples>`_,
+or browse the source code of the included components in module :mod:`.modules`.
+The source code of each API entry is linked in it's upper right corner under ``[source]``.
 
 Set up a Python project
 -----------------------

docs/source/finam-book/development/index.rst

@@ -6,6 +6,15 @@ The following chapters target developers that want to prepare their existing mod
 
 Besides preparation of models, implementation of adapters that mediate data between models is also covered.
 
+* Overview over FINAM's :doc:`interfaces`.
+* :doc:`components`.
+* :doc:`adapters`.
+* :doc:`data_metadata` in FINAM.
+* :doc:`connect_phase`.
+* Implementing :doc:`special_components`.
+* Using :doc:`logging`.
+* Writing :doc:`py-bindings` for models in languages other than Python.
+
 .. toctree::
     :hidden:
 

docs/source/finam-book/usage/index.rst

@@ -4,11 +4,9 @@ Using FINAM
 
 The following chapters target users that want to couple models that are already prepared for FINAM.
 
-Chapter :doc:`installation` covers how to install the FINAM Python package.
-
-Chapter :doc:`coupling_scripts` covers how to write Python scripts that compose and run model coupling setups.
-
-Chapter :doc:`known_modules` provides a list of known FINAM components and adapters for the use in coupling scripts.
+* :doc:`installation` on how to install the FINAM Python package.
+* How :doc:`coupling_scripts` are written that compose and run model coupling setups.
+* :doc:`known_modules` to get started with using FINAM's provided components and adapters.
 
 .. toctree::
     :hidden: