This is the repository of the Nek5000 documentation written in LaTeX.
-
'make' builds the user documentation in both PDF and HTML formats, as described below. A subdirectory (build) is created for the output.
-
'make pdf' builds the user documentation in PDF format. The PDF is a single file in the build directory (build/Nek_users.pdf).
-
'make html' builds the user documentation as a set of interlinked HTML and image files. The top-level table-of-contents is build/Nek_users.html. Supporting HTML and image files are also in the build directory.
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.
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:
- Create a fork of the repository
- Edit the 'master' branch
- Open a pull request
- Publish to GitHub pages after the pull request has been merged