diff options
Diffstat (limited to 'src/cython/doc/installation.rst')
| -rw-r--r-- | src/cython/doc/installation.rst | 54 |
1 files changed, 33 insertions, 21 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index 4359c744..12d35821 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -42,7 +42,9 @@ Documentation ============= To build the documentation, `sphinx-doc <http://http://www.sphinx-doc.org>`_ is -required. Run the following commands in a terminal: +required. Please refer to *conf.py* file to see which +`sphinx-doc <http://http://www.sphinx-doc.org>`_ modules are required to +generate the documentation. Run the following commands in a terminal: .. code-block:: bash @@ -56,7 +58,7 @@ CGAL The :doc:`Alpha complex </alpha_complex_user>` data structure and :doc:`Tangential complex </tangential_complex_user>` data structures, -:doc:`Bottleneck distance </bottleneck_distance_user>`requires CGAL, which is a +:doc:`Bottleneck distance </bottleneck_distance_user>` requires CGAL, which is a C++ library which provides easy access to efficient and reliable geometric algorithms. @@ -66,13 +68,17 @@ install this library according to your operating system is detailed The following examples require the Computational Geometry Algorithms Library: -* alpha_complex_diagram_persistence_from_off_file_example.py -* alpha_complex_from_points_example.py +.. only:: builder_html + + * :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>` + * :download:`alpha_complex_from_points_example.py <../example/alpha_complex_from_points_example.py>` The following example requires CGAL version ≥ 4.8.0: -* bottleneck_basic_example.py -* tangential_complex_plain_homology_from_off_file_example.py +.. only:: builder_html + + * :download:`bottleneck_basic_example.py <../example/bottleneck_basic_example.py>` + * :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>` Eigen3 ====== @@ -85,9 +91,11 @@ algorithms. The following examples require the `Eigen3 <http://eigen.tuxfamily.org/>`_: -* alpha_complex_diagram_persistence_from_off_file_example.py -* alpha_complex_from_points_example.py -* tangential_complex_plain_homology_from_off_file_example.py +.. only:: builder_html + + * :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>` + * :download:`alpha_complex_from_points_example.py <../example/alpha_complex_from_points_example.py>` + * :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>` Matplotlib ========== @@ -99,12 +107,14 @@ formats and interactive environments across platforms. The following examples require the `Matplotlib <http://matplotlib.org>`_: -* alpha_complex_diagram_persistence_from_off_file_example.py -* gudhi_graphical_tools_example.py -* periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py -* rips_complex_diagram_persistence_with_pandas_interface_example.py -* rips_persistence_diagram.py -* tangential_complex_plain_homology_from_off_file_example.py +.. only:: builder_html + + * :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>` + * :download:`gudhi_graphical_tools_example.py <../example/gudhi_graphical_tools_example.py>` + * :download:`periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py <../example/periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py>` + * :download:`rips_complex_diagram_persistence_with_pandas_interface_example.py <../example/rips_complex_diagram_persistence_with_pandas_interface_example.py>` + * :download:`rips_persistence_diagram.py <../example/rips_persistence_diagram.py>` + * :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>` Numpy ===== @@ -115,9 +125,11 @@ scientific computing with Python. The following examples require the `NumPy <http://numpy.org>`_: -* alpha_complex_diagram_persistence_from_off_file_example.py -* gudhi_graphical_tools_example.py -* periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py -* rips_complex_diagram_persistence_with_pandas_interface_example.py -* rips_persistence_diagram.py -* tangential_complex_plain_homology_from_off_file_example.py +.. only:: builder_html + + * :download:`alpha_complex_diagram_persistence_from_off_file_example.py <../example/alpha_complex_diagram_persistence_from_off_file_example.py>` + * :download:`gudhi_graphical_tools_example.py <../example/gudhi_graphical_tools_example.py>` + * :download:`periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py <../example/periodic_cubical_complex_barcode_persistence_from_perseus_file_example.py>` + * :download:`rips_complex_diagram_persistence_with_pandas_interface_example.py <../example/rips_complex_diagram_persistence_with_pandas_interface_example.py>` + * :download:`rips_persistence_diagram.py <../example/rips_persistence_diagram.py>` + * :download:`tangential_complex_plain_homology_from_off_file_example.py <../example/tangential_complex_plain_homology_from_off_file_example.py>` |