Doc stuff

doc/conf.py

@@ -26,7 +26,7 @@ for file in os.listdir('.'):
 
 notebooks = os.listdir('../tutorials')
 
-to_import = ['bvpy_tutorial_domain.ipynb']
+to_import = ['bvpy_tutorial_domain.ipynb', 'bvpy_tutorial_3_poissonEquation_FEniCSlike.ipynb']
 
 for i in notebooks:
     if '.' != i[0] and i in to_import:

doc/index.rst

-Welcome to bvpy's documentation!
-====================================================
+.. include:: substitutions.txt
+
+========================
+bvpy
+========================
+
+.. image:: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/badges/develop/coverage.svg
+  :target: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy
+
+.. image:: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/badges/develop/pipeline.svg
+  :target: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/pipelines
+
 .. toctree::
-   :caption: Developper's documentation
-   :maxdepth: 4
+   :caption: Table of contents
+   :maxdepth: 2
+   :hidden:
 
    Sources <_dvlpt/modules>
    report
    notebook
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Package providing tools to solve BVP (Boundary Value Problem) and IVP (Initial Value Problem).
+
+It rely on `FEniCS <https://fenicsproject.org/>`_ finite element library and `GMSH <http://gmsh.info/>`_.
+
+.. sidebar:: |name|
+
+  :Coordination: |coord|
+
+  :Contributors: |contrib|
+
+  :Active teams: Inria project-team `Mosaic <https://team.inria.fr/mosaic/>`_
+
+  :Stable release: |release|
+
+  :Written in: Python
+
+  :Supported OS: Linux, Mac OS
+  :Licence: `CeCILL-C licence <https://cecill.info/licences/Licence_CeCILL-C_V1-en.html>`_
+
+
+Requirements
+------------
+
+* Python 3.6+
+* FEniCS
+* GMSH
+
+
+Installation
+------------
+
+* From sources:
+
+.. code-block:: bash
+
+	python setup.py develop
+
+
+* On `Anaconda Cloud <https://anaconda.org/mosaic/femtk>`_:
+
+.. code-block:: bash
+
+	conda install -c mosaic -c conda-forge bvpy
+
+
+Examples
+--------
+
+You can find introduction for ``bvpy`` :ref:`here<tutorial_example>`

doc/notebook.rst

-.. _problem_example:
+.. _tutorial_example:
 
-Problems
-********
+Tutorials
+*********
 
 .. toctree::
   :titlesonly:
   :maxdepth: 1
 
   bvpy_tutorial_domain
+  bvpy_tutorial_3_poissonEquation_FEniCSlike

doc/substitutions.txt

+.. |coord| replace:: Florian Gacon, Olivier Ali
+.. |contrib| replace:: Christophe Godin
+.. |licence| replace:: Cecill-C
+.. |name| replace:: bvpy
+.. |gitlab_url| replace:: git@gitlab.inria.fr:mosaic/work-in-progress/femtk.git

src/bvpy/bvp.py

@@ -161,18 +161,14 @@ class BVP(object):
                                method='topological',
                                subspace=None,
                                degree=None):
-        """Add a boundary condition to the problem (Dirichlet or Neumann).
+        """Add a boundary condition to the problem (Dirichlet).
 
         Parameters
         ----------
         bnd_cond : :class:`ConstantDirichlet<femtk.boundary_conditions.
                                              dirichlet.ConstantDirichlet>`,
                    :class:`VariableDirichlet<femtk.boundary_conditions.
-                                             dirichlet.VariableDirichlet>`,
-                   :class:`ConstantNeumann<femtk.boundary_conditions.
-                                           neumann.ConstantNeumann>` or
-                   :class:`VariableNeumann<femtk.boundary_conditions.
-                                           neumann.VariableNeumann>`
+                                             dirichlet.VariableDirichlet>`
             Class representing a boundary condition
         method : str
             Method to apply Dirichlet condition
@@ -180,9 +176,7 @@ class BVP(object):
             Index of the subspace to constrain for Dirichlet (optional)
         degree : int
             Optional argument to determine the degree for
-            :class:`VariableNeumann<femtk.boundary_conditions.
-                                    neumann.VariableNeumann>`
-            and :class:`VariableDirichlet<femtk.boundary_conditions.
+            :class:`VariableDirichlet<femtk.boundary_conditions.
                                           dirichlet.VariableDirichlet>`
 
         Returns