Nek5000 Documentation

This is the repository of the Nek5000 documentation written using the Sphinx documentation framework.

How to build

• 'make html' builds the user documentation as a set of interlinked HTML and image files. The top-level webpage is build/html/index.html. Supporting HTML and image files are also in the build directory.

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.

How to publish on GitHub Pages

To update the GitHub Page, a contributor must have write permissions to the main NekDoc repository.
The GitHub Page should not contain any edits that are newer than the master branch of the main repository.

Workflow:

1. Checkout the latest master
2. run make gh-pages