Commit b32d7cf4 authored by Lukas Platz's avatar Lukas Platz
Browse files

add documentation build instructions to README

parent 5ccb48ba
Pipeline #68309 passed with stages
in 15 minutes and 10 seconds
...@@ -109,7 +109,6 @@ following command in the repository root: ...@@ -109,7 +109,6 @@ following command in the repository root:
pytest-3 --cov=nifty6 test pytest-3 --cov=nifty6 test
### First Steps ### First Steps
For a quick start, you can browse through the [informal For a quick start, you can browse through the [informal
...@@ -118,6 +117,14 @@ dive into NIFTy by running one of the demonstrations, e.g.: ...@@ -118,6 +117,14 @@ dive into NIFTy by running one of the demonstrations, e.g.:
python3 demos/getting_started_1.py python3 demos/getting_started_1.py
### Building the documentation from source
To build the documentation from source, install
[sphinx](https://www.sphinx-doc.org/en/stable/index.html) and the
[Read The Docs Sphinx Theme](https://github.com/readthedocs/sphinx_rtd_theme)
on your system and run
sh docs/generate.sh
### Acknowledgements ### Acknowledgements
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment