clean up docs and readme

anuga-community · Jun 26, 2022 · 564d7c8 · 564d7c8
1 parent 939d7e7
commit 564d7c8
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 32 deletions.
diff --git a/README.rst b/README.rst
@@ -9,16 +9,24 @@
 
 .. image:: https://img.shields.io/pypi/v/anuga.svg
     :target: https://pypi.python.org/pypi/anuga/
-    :alt: Latest Version
+    :alt: Latest PyPi Version
+
+.. image:: https://img.shields.io/pypi/dm/anuga.svg
+    :target: https://pypistats.org/packages/anuga
+    :alt: PyPi download statistics
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/anuga.svg
+    :target: https://anaconda.org/conda-forge/anuga
+    :alt: Latest Conda Version
+
+.. image:: https://img.shields.io/conda/dn/conda-forge/anuga.svg
+    :target: https://anaconda.org/conda-forge/anuga
+    :alt: Conda Forge download statistics
 
 .. image:: https://readthedocs.org/projects/anuga/badge/?version=latest
     :target: https://anuga.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
 
-.. image:: https://img.shields.io/pypi/dm/anuga.svg
-    :target: https://pypistats.org/packages/anuga
-    :alt: Python package index download statistics
-
 
 =====
 ANUGA
@@ -61,7 +69,20 @@ The python 3 version of ANUGA will continue to be developed and the most up-to-d
 Installation
 ------------
 
-For installation instructions, see https://anuga.readthedocs.io/en/latest/installation.html
+Installing anuga from the conda-forge channel can be achieved by adding conda-forge to your channels with:
+
+    conda config --add channels conda-forge
+    conda config --set channel_priority strict
+
+
+Once the conda-forge channel has been enabled, anuga can be installed with conda:
+
+
+    conda install anuga
+
+
+
+For more detailed installation instructions, see https://anuga.readthedocs.io/en/latest/installation.html
 
 
 Documentation and Help

diff --git a/anuga/extras.py b/anuga/extras.py
@@ -120,8 +120,8 @@ def create_domain_from_regions(bounding_polygon,
 
     .. note:: 
     
-    Interior regions should be fully nested, as overlaps may cause
-    unintended resolutions. 
+        Interior regions should be fully nested, as overlaps may cause
+        unintended resolutions. 
   
     
     """

diff --git a/docs/source/examples/introduction.rst b/docs/source/examples/introduction.rst
diff --git a/docs/source/examples/real_example.rst b/docs/source/examples/real_example.rst
diff --git a/docs/source/examples/script_simple_example.rst b/docs/source/examples/script_simple_example.rst
@@ -208,8 +208,8 @@ using the statement:
     domain.set_quantity('stage', -0.4)
 
 
-which specifies that the surface level is set to a height of $-0.4$,
-i.e.\ 0.4 units (metres) below the zero level.
+which specifies that the surface level is set to a height of :math:`-0.4`,
+i.e. 0.4 units (metres) below the zero level.
 
 Although it is not necessary for this example, it may be useful to
 digress here and mention a variant to this requirement, which allows

diff --git a/docs/source/reference/domain.rst b/docs/source/reference/domain.rst
@@ -12,7 +12,7 @@ Classes Associated with the Domain
 
 
 .. autosummary::
-   :toctree:  generated
+   :toctree: 
 
    anuga.Domain
    anuga.Quantity