fix link to example-data files in the documentation

and of the class referenced in the documentation
example-data folder is not accessible from the
generated pages on readthedocs. So use hyperlinks
to the files  github repo.

Signed-off-by: EstherLerouzic <esther.lerouzic@orange.com>
Change-Id: I135e2cb0b0d28fecffcbcbfec9a9d6c8cb5c7347

docs/conf.py

@@ -20,6 +20,7 @@
 import os
 import sys
 
+
 sys.path.insert(0, os.path.abspath('../'))
 
 # -- General configuration ------------------------------------------------

docs/intro.rst

@@ -23,18 +23,18 @@ or to run a planning script to check SNR of several services:
    :alt: Running a simple simulation example
 
 By default, the gnpy-transmission-example script operates on a single span network defined in
-`gnpy/example-data/edfa_example_network.json <../gnpy/example-data/edfa_example_network.json>`_
+`gnpy/example-data/edfa_example_network.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/edfa_example_network.json>`_
 
 You can specify a different network at the command line as follows. For
 example, to use the CORONET Global network defined in
-`gnpy/example-data/CORONET_Global_Topology.json <../gnpy/example-data/CORONET_Global_Topology.json>`_:
+`gnpy/example-data/CORONET_Global_Topology.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/CORONET_Global_Topology.json>`_:
 
 .. code-block:: shell-session
 
     $ gnpy-transmission-example $(gnpy-example-data)/CORONET_Global_Topology.json
 
 It is also possible to use an Excel file input (for example
-`gnpy/example-data/CORONET_Global_Topology.xls <../gnpy/example-data/CORONET_Global_Topology.xls>`_).
+`gnpy/example-data/CORONET_Global_Topology.xls <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/CORONET_Global_Topology.xls>`_).
 The Excel file will be processed into a JSON file with the same prefix.
 Further details about the Excel data structure are available `in the documentation <excel.rst>`__.
 
@@ -72,8 +72,8 @@ An experimental support for Raman amplification is available:
        $(gnpy-example-data)/raman_edfa_example_network.json \
        --sim $(gnpy-example-data)/sim_params.json --show-channels
 
-Configuration of Raman pumps (their frequencies, power and pumping direction) is done via the `RamanFiber element in the network topology <../gnpy/example-data/raman_edfa_example_network.json>`_.
+Configuration of Raman pumps (their frequencies, power and pumping direction) is done via the `RamanFiber element in the network topology <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/raman_edfa_example_network.json>`_.
-General numeric parameters for simulation control are provided in the `gnpy/example-data/sim_params.json <../gnpy/example-data/sim_params.json>`_.
+General numeric parameters for simulation control are provided in the `gnpy/example-data/sim_params.json <https://github.com/Telecominfraproject/oopt-gnpy/blob/master/gnpy/example-data/sim_params.json>`_.
 
 Use ``gnpy-path-request`` to request several paths at once:
 

docs/json_instance_examples.rst

@@ -364,13 +364,13 @@ backward compatibility.
 The RamanFiber is a specialized variant of the regular Fiber, where the simulation
 engine incorporates Raman amplification. The actual pump definitions must be
 specified within the RamanFiber instance in the topology
-(refer to the gnpy.core.elements.RamanFiber class).
+(refer to the :mod:`gnpy.core.elements.RamanFiber` class).
 
 More details can be found in :cite:curri_merit_2016.
 
 Raman efficiency is scaled against the effective area using the default Raman
 coefficient profile (g0 * A_ff_overlap), where g0 is a Raman coefficient profile
-defined for a reference effective area (gnpy.core.parameters.DEFAULT_RAMAN_COEFFICIENT).
+defined for a reference effective area (:mod:`gnpy.core.parameters.DEFAULT_RAMAN_COEFFICIENT`).
 
 If a RamanFiber is defined in the library, a corresponding Fiber must also be defined
 with the same type_variety.