nekRS Documentation

This subdirectory contains documentation of the nekRS project using the Sphinx documentation framework. A read the docs website is hosted here.

How to build locally

If you are developing the documentation you can preview the website locally before a pull request is merged.

Dependencies

The documentation requires the following:

• A python 3 installation
• The pip packages detailed in requirements.txt (including Sphinx and sphinx_rtd_theme)
• Doxygen
• Make

In case you don't have the appropriate git and python dependencies these can be installed if using Debian/Ubuntu using the following command. If using alternative setups this may need adapting appropriately

apt update && apt install -y git doxygen build-essential python3 python3-venv

You can then clone the nekRS repository.

git clone https://github.com/Nek5000/nekRS_doc.git

The recommended way to setup the build environment is to create a local venv and then install the packages via the requirement.txt file.

cd doc
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

This environment can be disabled with deactivate. It can re-enabled from any terminal with source $NEKRS_HOME/doc/venv/bin/activate

Building

Once the dependencies have been acquired make html (from the doc directory) builds the user documentation as a set of interlinked HTML and image files. The top-level webpage is build/html/index.html. To view this documentation as a navigable HTML web page, simply navigate to the build/html/index.html file in your file system and open with a web browser.

How to contribute

Please create a fork of the repository and make pull/merge requests. Keep in mind that the number of binary files should be kept minimal. The Makefile should be adapted to any special build requirements.

New issues or requests are welcome to be reported.