diff options
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..9fd78df --- /dev/null +++ b/doc/README.md @@ -0,0 +1,41 @@ +# Documentation Generation + +## Requirements + +You'll need the following software: +- [Sphinx](http://www.sphinx-doc.org/en/master/index.html) + +### Ubuntu + +You can install the required software on Ubuntu with the following: + +``` +sudo apt install python3-sphinx +``` + +The second line can be omitted if you don't intend to build the PDF. + +### MacOS + +You can install the required software on MacOS with the following: + +``` +brew install sphinx-doc +``` + +The second line can be omitted if you don't intend to build the PDF. + +## Building the Docs + +You can generate the HTML documentation with +``` +make +``` + +You can clean the build files and outputs with + +``` +make clean +``` + + |