How To Build The Documentation

User Support
1

Just so people looking for information in the future know, to build the documentation, you use the Sphinx-Build program.
http://sphinx-doc.org/index.html

The command should be:
sphinx-build ./source ./output

where ./source is the source directory in the doc directory of the OpenMC source and output is the output directory you’ve made.

Thought I should post this; I didn’t see anything in the documentation online building the documentation.

2

Thanks Terry. There’s also a Makefile in openmc/docs so you can run ‘make html’ from that directory and you’ll get a build directory with the documentation built. I’ll add something in the documentation too about how to build the documentation – thanks for pointing that out!

Best regards,
Paul