more updates to docs

N3PDF · Mar 1, 2020 · c2ad1a3 · c2ad1a3
1 parent beed399
commit c2ad1a3
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 23 deletions.
diff --git a/doc/source/apisrc/vegasflow.rst b/doc/source/apisrc/vegasflow.rst
@@ -1,6 +1,14 @@
 vegasflow package
 =================
 
+Module contents
+---------------
+
+.. automodule:: vegasflow
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -37,10 +45,4 @@ vegasflow.utils module
    :show-inheritance:
 
 
-Module contents
----------------
 
-.. automodule:: vegasflow
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/doc/source/how_to.rst b/doc/source/how_to.rst
@@ -6,6 +6,16 @@ How to use
 
 ``vegasflow`` is a python library that provides a number of functions to perform Monte Carlo integration of some functions.
 
+.. contents::
+   :local:
+   :depth: 1
+
+
+A first VegasFlow integration
+=============================
+
+Prototyping in VegasFlow is easy, the best results are obtained when the interands are written using TensorFlow primitives.
+Below we show one example where we create a TF constant (using ``tf.constant``) and then we use the sum and power functions.
 
 .. code-block:: python
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,12 +1,17 @@
 .. title::
     vegasflow's documentation!
 
+
 ========================
 VegasFlow: accelerating Monte Carlo simulation across multiple hardware platforms
 ========================
 
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3691927.svg
-   :target: https://doi.org/10.5281/zenodo.3691927
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3691926.svg
+   :target: https://doi.org/10.5281/zenodo.3691926
+
+.. contents::
+   :local:
+   :depth: 1
 
 VegasFlow is a `Monte Carlo integration <https://en.wikipedia.org/wiki/Monte_Carlo_integration>`_ library written in Python and based on the `TensorFlow <https://www.tensorflow.org/>`_ framework.
 It is developed with a focus on speed and efficiency, enabling researchers to perform very expensive calculation as quick and easy as possible.
@@ -17,6 +22,7 @@ Some of the key features of VegasFlow are:
     - Compatible with Python, C, C++ or Fortran.
     - Implementation of different Monte Carlo algorithms.
 
+
 Motivation
 ==========
 
@@ -32,17 +38,9 @@ To that end VegasFlow is based on two technologies that together will enable a n
     - `TensorFlow <https://www.tensorflow.org/>`_: the framework developed by Google and made public in November of 2015 is a perfect combination between performance and usability. With a focus on Deep Learning, TensorFlow provides an algebra library able to easily run operations in many different devices: CPUs, GPUs, TPUs with little input by the developer. Write your code once.
 
 
-FAQ
-===
-
-Why the name ``vegasflow``?
----------------------------
-
-It is a combination of the names `Vegas` and `Tensorflow`.
-
 
 How to cite ``vegaflow``?
--------------------------
+=========================
 
 When using ``vegasflow`` in your research, please cite the following publications:
 
@@ -66,23 +64,30 @@ hep-ph/20...
         url          = {https://doi.org/10.5281/zenodo.3691926}
     }
 
+FAQ
+===
+
+Why the name ``vegasflow``?
+---------------------------
+
+It is a combination of the names `Vegas` and `Tensorflow`.
+
 
 
 
 Indices and tables
 ==================
 
 .. toctree::
-    :maxdepth: 4
+    :maxdepth: 3
+    :glob: 
     :caption: Contents:
 
-    index
+    VegasFlow<self>
     how_to
     intalg
-
-.. automodule:: vegasflow
-    :members:
-
+    apisrc/vegasflow
+
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/doc/source/intalg.rst b/doc/source/intalg.rst
@@ -6,6 +6,10 @@ Integration algorithms
 
 This page lists the integration algorithms currently implemented.
 
+.. contents::
+   :local:
+   :depth: 1
+
 .. _vegas-label:
 
 VegasFlow