Merge pull request #516 from RemDelaporteMathurin/dev

Minor doc fixes

README.md

@@ -7,24 +7,11 @@
 ![GitHub forks](https://img.shields.io/github/forks/RemDelaporteMathurin/FESTIM.svg?logo=github&label=Forks&logoColor=white)
 
 FESTIM (Finite Elements Simulation of Tritium in Materials) is a tool for modeling hydrogen transport in materials. 
-FESTIM simulates the diffusion and trapping of hydrogen, coupled to heat transfer.
+It simulates the diffusion and trapping of hydrogen, coupled to heat transfer with [FEniCS](https://fenicsproject.org).
 
+:point_right: [Documentation](https://festim.readthedocs.io/)
 
-The following features are included:
-- Mesh import from XDMF files
-- **Adaptive stepsize**
-- **Temperature** from solving transient/stationnary heat equation
-- Multiple intrinsic/extrinsic traps with **non-homogeneous density distribution**
-- Wide range of built-in boundary conditions (Sievert's law, recombination flux, user-defined expression...)
-- **Derived quantities** computation (surface fluxes, volume integrations, extrema over domains, mean values over domains...)
-- Soret effect
-- ...
-
-FESTIM spatially discretises the PDEs using the Finite Element Methods and heavily relies on [FEniCS](https://fenicsproject.org).
-
-:point_right: [Examples](https://github.com/RemDelaporteMathurin/FESTIM/tree/main/demos).
-
-:point_right: [Documentation](https://festim.readthedocs.io/en/latest/)
+:point_right: [Examples](https://github.com/RemDelaporteMathurin/FESTIM/tree/main/demos)
 
 
 ## Installation
@@ -51,9 +38,6 @@ Run the tests:
 
 ## Visualisation
 FESTIM results are exported to .csv, .txt or XDMF. The latter can then be opened in visualisation tools like [ParaView](https://www.paraview.org/) or [VisIt](https://wci.llnl.gov/simulation/computer-codes/visit/).
-<p align="center">
-  <img alt="performance" src="https://user-images.githubusercontent.com/40028739/69346147-9abb6980-0c72-11ea-80e7-9c0a76659268.png" width="40%"> <img alt="performance" src="https://user-images.githubusercontent.com/40028739/69346752-9d6a8e80-0c73-11ea-96c1-27b6104eb9ff.png" width="40%">
-</p>
 
 ## References
 - R. Delaporte-Mathurin, _et al._, _Finite Element Analysis of Hydrogen Retention in ITER Plasma Facing Components using FESTIM_. Nuclear Materials and Energy 21: 100709. DOI: [10.1016/j.nme.2019.100709](https://doi.org/10.1016/j.nme.2019.100709).

docs/source/conf.py

@@ -67,4 +67,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]

docs/source/index.rst

@@ -21,11 +21,9 @@ FESTIM was originally developped at the `Institute for Magnetic Fusion Research
    "`Finite Element Analysis of Hydrogen Retention in ITER Plasma Facing Components Using FESTIM.
    Nuclear Materials and Energy 21 (2019): 100709. <https://doi.org/10.1016/j.nme.2019.100709>`_",
 
-.. only:: html
-
-   --------
-   Contents
-   --------
+--------
+Contents
+--------
 
 .. toctree::
    :maxdepth: 1