Hi there 👋 and welcome to the TrioCFD Documentation project page! The documentation is devoted to describe the TrioCFD fluid dynamics code.
The documentation is built with the the open source Sphinx and Doxygen projects.
Credits for the open-source Sphinx Material Theme, Doxygen Awesome Theme and Read The Docs projects.
git clone [email protected]:cea-trust-platform/triocfd-documentation.git
python -m venv .venv
source .venv/bin/activate
pip install sphinx sphinx_material myst_parser
# or
pip install -r doc/requirements.txt
cd doc
make htmlUse your web browser to open the index file located at build/html/index.html.
To produce a pdf, one must have latexmk installed and run make latexpdf.
Two formats can be used in Sphinx, reStructuredText and Markdown. The complete markdown syntax is described by the MyST Syntaxe Guide.
To write math, the dollar separated syntax from LaTeX works as well as environment like \begin{align}. One can also write in markdown without latex
{math}`k-\varepsilon`
to produce \begin{align}.
The bibliography is managed by a bibtex sphinx module. In markdown, one must use {cite:t} to produce Author et al. [key].
The website is deployed on readthedocs.
Build and deploy is triggered automatically when pushing on master branch.
Build status is available at https://app.readthedocs.org/projects/triocfd-documentation/builds/.