festim-dev / FESTIM

Coupled hydrogen/tritium transport and heat transfer modelling using FEniCS
https://festim.readthedocs.io/en/stable/
Apache License 2.0
92 stars 24 forks source link

Documentation: how to test the documentation #884

Open RemDelaporteMathurin opened 2 months ago

RemDelaporteMathurin commented 2 months ago

After discussing with @XinShen-CHN I realised we don't explain how to test the documentation with doctest.

The command is simply:

make doctest

Instead of make html.

This should be added to the Documentation Guide