Fix doc

doc/conf.py

@@ -88,6 +88,7 @@
         "image_dark": "_static/xoa-logo-dark.png",
     },
     "repository_url": "https://github.com/shom-fr/xoa",
+    "repository_branch": "develop",
     "use_repository_button": True,
     "use_issues_button": True,
     "use_source_button": True,

doc/howtostart.rst

@@ -1,13 +1,15 @@
-How to start
-============
+.. _howtostart:
 
+How to get started
+==================
 
-Reading the documentation
+
+Read the documentation
 -------------------------
 
 You should probably start with the :ref:`examples` section.
-This collection of examples will be progressively completed
-to cover almost all the features of the library.
+This collection of examples will gradually be completed
+to cover almost all features of the library.
 
 Some of the modules that are special or of particular interest
 are described in the :ref:`uses` section.
@@ -16,7 +18,7 @@ are described in the :ref:`uses` section.
 Using the library
 -----------------
 
-Like most of all xarray-based projects, xoa not only provides
-a :ref:`library <api>` but also :ref:`accessors <accessors>` for a convenient
-access to part the fonctionalities.
-The two uses are demonstrated in the pratical examples.
+Like most xarray-based projects, xoa provides not only a
+a :ref:`library <api>` but also :ref:`accessors <accessors>` for convenient access to part of the
+access to part of the functionality.
+Both uses are demonstrated in the practical examples.

doc/install.rst

@@ -1,5 +1,7 @@
-Installation
-============
+.. _install:
+
+How to install
+==============
 
 .. highlight:: bash
 
@@ -12,23 +14,22 @@ xoa requires ``python>3`` and depends on the following packages:
    :widths: 10 90
 
    * - `appdirs <http://github.com/ActiveState/appdirs>`_
-     - A small Python module for determining appropriate platform-specific
-       dirs, e.g. a "user data dir".
+     - A small Python module to determine appropriate platform specific dirs, e.g. a "user data dir".
    * - `cmocean <https://matplotlib.org/cmocean>`_
      - Beautiful colormaps for oceanography.
    * - `configobj <https://configobj.readthedocs.io/en/latest/configobj.html>`_
      - ConfigObj is a simple but powerful config file reader and writer:
-       an ini file round tripper.
+       an ini file round-tripper.
    * - `gsw <https://teos-10.github.io/GSW-Python/>`_
      - gsw is the python implementation of the Thermodynamic Equation of
        Seawater 2010 (TEOS-10).
    * - `matplotlib <https://matplotlib.org/>`_
      - Matplotlib is a comprehensive library for creating static, animated,
-       and interactive visualizations in Python.
+       and interactive visualisations in Python.
    * - `numba <https://numba.pydata.org/>`_
      - A high performance python compiler.
    * - `pandas <https://pandas.pydata.org/>`_
-     - pandas is a fast, powerful, flexible and easy to use open source
+     - pandas is a fast, powerful, flexible and easy-to-use open source
        data analysis and manipulation tool, built on top of the
        Python programming language.
    * - `scipy <https://www.scipy.org/scipylib/index.html>`_
@@ -40,7 +41,6 @@ xoa requires ``python>3`` and depends on the following packages:
        with labelled multi-dimensional arrays simple, efficient, and fun!
 
 
-
 From packages
 -------------
 

examples/plot_croco_section.py

@@ -89,6 +89,7 @@
 
 tempz = regrid1d(temp, depth, extrap="top")
 
+# %%
 # Compute the mixed layer depths
 # -------------------------------
 #