Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Neel Shah
NIFTy
Commits
faac9fba
Commit
faac9fba
authored
Dec 04, 2017
by
Philipp Frank
Browse files
updated sphinx howto
parent
708e7aa1
Changes
2
Hide whitespace changes
Inline
Side-by-side
docs/howto.txt
0 → 100644
View file @
faac9fba
Required packages:
sphinx
numpydoc
sphinx_rtd_theme
#Two step creation of webpages:
sphinx-apidoc -l -e -d 3 -o docs/source/mod/ nifty/ nifty/plotting/ nifty/spaces/power_space/power_indices.py nifty/spaces/power_space/power_index_factory.py nifty/config/ nifty/basic_arithmetics.py nifty/nifty_meta.py nifty/random.py nifty/version.py nifty/field_types/ nifty/operators/fft_operator/transformations/rg_transforms.py
#creates all .rst files neccesary for ModuleIndex excluding helper modules
sphinx-build -b html docs/source/ docs/build/
#generates html file and build directory
docs/howtogenerate.txt
deleted
100644 → 0
View file @
708e7aa1
Two step creation of webpages:
sphinx-apidoc -l -e -d 3 -o sphinx/source/mod/ nifty/ nifty/plotting/ nifty/spaces/power_space/power_indices.py nifty/spaces/power_space/power_index_factory.py nifty/config/ nifty/basic_arithmetics.py nifty/nifty_meta.py nifty/random.py nifty/version.py nifty/field_types/ nifty/operators/fft_operator/transformations/rg_transforms.py
creates all .rst files neccesary for ModuleIndex excluding helper modules
sphinx-build -b html sphinx/source/ sphinx/build/
generates html filel amd build directory
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a 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