The documentation site for Feel++ has been vastly updated during the summer.
Manual list
The list of manuals has been simplified
You have both versioned and unversioned manuals. Versioning is not always helpful.
Note that the versioned manuals follow the versions of Feel++.
Toolboxes manual
The Feel++ toolboxes manual has been reorganized and beautified
A gallery system is used to present the toolboxes, case studies and benchmarks as well as toolbox manuals. All toolboxes are presented the same way
Check out https://docs.feelpp.org/toolboxes/latest/csm/index.html for example
Manuals
Benchmarks
Case studies
Jupyter Notebooks
Jupyter notebook can be downloaded for some pages, they usually included example code that can be run and tested. Check out for example the page documenting expressions
Simply click on .ipynb to download the notebook.
Note that you will need to install Feel++ or to open the github reposytory in vscode using Docker.
How do you know however that the page is correct ? well see the next section
Dynamic Pages or docs as code
We use the excellent framework Antora and Asciidoc as format. Thanks to Antora and the joint work with @ggrossetie we now have support to execute code when generating our documentation.
This is the case of the page documenting expressions for example and you can see the results of the code generated automatically be it text, plotly graphics or pyvista outputs
Here is a text output
Here is a plotly output
Search box
Indexing configuration with Algolia has been updated to correspond properly to the latest changes in the documentation.
Now latest version documentation will appear in the search