feat: move and update documentation on equipment types

Signed-off-by: EstherLerouzic <[email protected]> Change-Id: I0f85a059e2393d2d573938bd0804fe49596bbc2d
Orange-OpenSource · Jan 10, 2025 · 0aef635 · 0aef635
1 parent 2f50502
commit 0aef635
Show file tree

Hide file tree

Showing 4 changed files with 829 additions and 561 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ in real-world mesh optical networks. It is based on the Gaussian Noise Model.
    cli_options
    amplifier_models_description
    json
+   json_instance_examples
    excel
    extending
    about-project

diff --git a/docs/json.rst b/docs/json.rst
@@ -11,9 +11,11 @@ Equipment Library
 
 Design and transmission parameters are defined in a dedicated json file.
 By default, this information is read from `gnpy/example-data/eqpt_config.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/eqpt_config.json>`_.
-This file defines the equipment libraries that can be customized (EDFAs, fibers, and transceivers).
+This file defines the equipment libraries that can be customized (Amplifiers, ROADMs, fibers, and transceivers).
 
-It also defines the simulation parameters (spans, ROADMs, and the spectral information to transmit.)
+It also defines the simulation parameters (spans and the spectral information to transmit.)
+
+Examples of instances are commented here :ref:`json instances examples<json-instance-examples>`.
 
 EDFA
 ~~~~