Building Documentation for NekROM

Instructions to Build Documentation

1. Install Dependencies

Set Up a Conda Environment (Optional)

You may use an existing Conda environment, but we recommend creating and activate a new environment:

conda create -n nekrom-docs
conda activate nekrom-docs
conda install pip

Install Documentation Dependencies

pip install sphinx sphinx-fortran six sphinx-mathjax-offline sphinx-book-theme myst-parser sphinxcontrib-bibtex sphinxcontrib-matlabdomain "numpy>=2.2.5"

2. Build the NekROM Documentation

Clone NekROM and build the HTML documentation:

git clone https://github.com/Nek5000/NekROM.git
cd NekROM/doc
make html

3. View the Documentation

To view the generated documentation, navigate to the build directory and open index.html in your browser:

cd NekROM/doc/build
open index.html

Useful Resources

• Using Sphinx with Fortran

• Example Fortran Repository

• Sphinx-Fortran Documentation

• VACUMM Sphinx-Fortran

Refactoring Fortran Code for Documentation

Follow this guide to refactor source code so that data appears correctly in the documentation.