Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ift
NIFTy
Commits
b32d7cf4
Commit
b32d7cf4
authored
Jan 30, 2020
by
Lukas Platz
Browse files
add documentation build instructions to README
parent
5ccb48ba
Pipeline
#68309
passed with stages
in 15 minutes and 10 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
b32d7cf4
...
...
@@ -109,7 +109,6 @@ following command in the repository root:
pytest-3 --cov=nifty6 test
### First Steps
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.:
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
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment