Nek5000 Documentation

This is the repository of the Nek5000 documentation written in reStructuredText.

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 SPHINX

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

The Makefile target 'make gh-pages' will build and publish the HTML on the NekDoc GitHub Page.

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. Thus it is highly recommended to update the main repository (through a merge/pull request, see 'How to contribute') before publishing to the GitHub Page.

In summary, contributors who wish to update the GitHub Page should follow this workflow:

1. Create a fork of the repository
2. Edit the 'master' branch
3. Open a pull request
4. Publish to GitHub pages after the pull request has been merged