Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Open sidebar
bellotti_r
pyOPALTools
Commits
f60c0917
Commit
f60c0917
authored
Jun 07, 2019
by
bellotti_r
Browse files
Update README.md
parent
837bce7f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
0 deletions
+13
-0
README.md
README.md
+13
-0
No files found.
README.md
View file @
f60c0917
...
...
@@ -174,4 +174,17 @@ to export the path variable, i.e.
$ export PATH=/absolute/path/to/build/bin:$PATH
```
Generation of documentation
===========================
The Sphinx documentation of all modules, classes, functions etc. can be automatically generated by executing the following commands:
```
cd doc
./add_new_files_to_doc.sh
make html
```
This will generate the documentation in the directory ```doc/build/```.
It can be viewed by opening ```doc/build/html/index.html``` in your browser of choice.
Building PDF documentation should also be possible, but is not tested yet.
Note: Executing ```add_new_files_to_doc.sh``` is only necessary if new Python modules have been added before the last build.
\ No newline at end of file
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