update module documentation

docs/modules/FortranInterface.rst

@@ -5,8 +5,6 @@
 
 ..  We allow the template to be standalone, so that the library maintainers add it in the right place
 
-:orphan:
-
 ..  Firstly, let's add technical info as a sidebar and allow text below to wrap around it. This list is a work in
     progress, please help us improve it. We use *definition lists* of ReST_ to make this readable.
 
@@ -39,7 +37,7 @@
     unique otherwise you will cause cross-referencing errors. The reference must come right before the heading for the
     reference to work (so don't insert a comment between).
 
-.. _allFortranInterface:
+.. _all_fortran_interface:
 
 #####################
 ALL Fortran interface
@@ -68,9 +66,13 @@ _________________
 This module is necessary for any Fortran developers trying to use this
 library.
 
+.. It is currently in use by the Fortran Multi Particle Method written for
+   the thesis of Stephan Schulz. This application of the interface is
+   documented in the according :ref:`module<all_mpm_integration>`.
+
 It is currently in use by the Fortran Multi Particle Method written for
 the thesis of Stephan Schulz. This application of the interface is
-documented in the according :ref:`module<allMPMIntegration>`.
+documented in the module :ref:`all_mpm_integration`.
 
 .. TODO:
 
@@ -117,8 +119,8 @@ ___________
 .. Notice the syntax of a URL reference below `Text <URL>`_ the backticks matter!
 
 The source code for this interface consists of the C wrapper
-`src/ALL_fortran.cpp <https://gitlab.version.fz-juelich.de/SLMS/loadbalancing/-/blob/refactor/src/ALL_fortran.cpp>`_
-and the Fortran module ALL
-`src/ALL_module.F90 <https://gitlab.version.fz-juelich.de/SLMS/loadbalancing/-/blob/refactor/src/ALL_module.F90>`_.
+`src/ALL_fortran.cpp <https://gitlab.version.fz-juelich.de/SLMS/loadbalancing/-/blob/master/src/ALL_fortran.cpp>`_
+and the Fortran module `ALL`
+`src/ALL_module.F90 <https://gitlab.version.fz-juelich.de/SLMS/loadbalancing/-/blob/master/src/ALL_module.F90>`_.
 
 .. vim: et sw=2 ts=2 tw=74 spell spelllang=en_us:

docs/modules/MPMIntegration.rst

@@ -5,8 +5,6 @@
 
 ..  We allow the template to be standalone, so that the library maintainers add it in the right place
 
-:orphan:
-
 ..  Firstly, let's add technical info as a sidebar and allow text below to wrap around it. This list is a work in
     progress, please help us improve it. We use *definition lists* of ReST_ to make this readable.
 
@@ -19,7 +17,7 @@
     Fortran/C/C++
 
   Licence
-    TBD!
+    `BSD 3-Clause <https://choosealicense.com/licenses/bsd-3-clause/>`_   
 
   Documentation Tool
     In source documentation using Doxygen, additional man pages and plain
@@ -40,7 +38,7 @@
     unique otherwise you will cause cross-referencing errors. The reference must come right before the heading for the
     reference to work (so don't insert a comment between).
 
-.. _allMPMIntegration:
+.. _all_mpm_integration:
 
 ###############
 MPM Integration
@@ -80,8 +78,12 @@ code are also shown. Looking at these will help determine whether a
 simulation code is particularly suited for integrating ALL or if some
 further work is needed when integrating.
 
-This module also shows a real world application of the :ref:`Fortran
-interface<allFortranInterface>` provided with :ref:`ALL<ALL_background>`.
+.. This module also shows a real world application of the :ref:`Fortran
+   interface<all_fortran_interface>` provided with
+   :ref:`ALL<ALL_background>`.
+
+This module also shows a real world application of the Fortran interface
+provided with :ref:`ALL<ALL_background>` (documented in :ref:`all_fortran_interface`).
 
 The MPM simulation code with integrated ALL is used by Stephan Schulz in
 his thesis.
@@ -96,14 +98,19 @@ ______________________
 
 .. Keep the helper text below around in your module by just adding "..  " in front of it, which turns it into a comment
 
-.. If the modifications are to an existing code base (which is typical) then this would be the place to name that
-   application. List any relevant urls and explain how to get access to that code. There needs to be enough information
-   here so that the person reading knows where to get the source code for the application, what version this information is
-   relevant for, whether this requires any additional patches/plugins, etc.
+.. If the modifications are to an existing code base (which is typical)
+   then this would be the place to name that application. List any
+   relevant urls and explain how to get access to that code. There needs
+   to be enough information here so that the person reading knows where to
+   get the source code for the application, what version this information
+   is relevant for, whether this requires any additional patches/plugins,
+   etc.
 
-.. Overall, this module is supposed to be self-contained, but linking to specific URLs with more detailed information is
-   encouraged. In other words, the reader should not need to do a websearch to understand the context of this module, all
-   the links they need should be already in this module.
+.. Overall, this module is supposed to be self-contained, but linking to
+   specific URLs with more detailed information is encouraged. In other
+   words, the reader should not need to do a websearch to understand the
+   context of this module, all the links they need should be already in
+   this module.
 
 The load balancing library ALL is integrated into the material point
 method simulation code GMPM-PoC, which is written by Stephan Schulz during
@@ -163,7 +170,7 @@ ____________________
 To build the code just run ``make LB=ALL`` and everything should be build
 automatically including dependencies. Make sure the correct compiler are
 found in the path and if you want to use Intel compilers you need to set
-``COPMILER=INTEL`` as well. The normal caveats and required modules for
+``COMPILER=INTEL`` as well. The normal caveats and required modules for
 some HPC systems are the described in the main code's ``README``.
 
 Source Code