nekRS Documentation

This repository 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 documentation and want to preview the website before a pull request is merged, make html 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.

Note: This requires the Sphinx and sphinx_rtd_theme Python packages. Both are available from the Python Package Index.

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.