Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
ACS
Public
Power System Simulation and Optimization
DPsim
DPsim
Commits
c7d77177
Commit
c7d77177
authored
Dec 01, 2017
by
Markus Mirz
Browse files
updated readme and build instructions
parent
b3016252
Changes
2
Hide whitespace changes
Inline
Side-by-side
Documentation/build.rst
View file @
c7d77177
Build
Build
DPsim
=====
Windows (Visual Studio)
...
...
@@ -46,3 +46,33 @@ Linux (CMake)
.. _Eigen: http://eigen.tuxfamily.org
.. _CMake: https://cmake.org/download/
.. _VILLASnode: https://git.rwth-aachen.de/VILLASframework/VILLASnode
Build Documentation
=====
Python
-----------------------
1. Install [Sphinx](http://www.sphinx-doc.org/en/stable/index.html)
- either from your Linux distribution's repo
- or [manually](http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx) on Windows
- if you used the installer which already adds Python to your path and installs pip, you basically only need to run `pip install sphinx`
2. Generate the Python documentation by running Sphinx via CMake:
```
$ mkdir -p build
$ cd build
$ cmake ..
$ make docs
```
4. The resulting documentation will be generated in `Documentation/html/`
C++
-----------------------
1. Install Doxygen
2. Generate the C++ documentation by running Doxygen via CMake:
```
$ mkdir -p build
$ cd build
$ cmake ..
$ make docs_cxx
```
4. The resulting documentation will be generated in `Documentation/html/Cxx`
\ No newline at end of file
README.md
View file @
c7d77177
...
...
@@ -25,26 +25,13 @@ Please check out the existing [Python examples](Examples/Python/).
## Documentation
1.
Install
[
Sphinx
](
http://www.sphinx-doc.org/en/stable/index.html
)
-
either from your Linux distribution's repo
-
or
[
manually
](
http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx
)
on Windows
-
if you used the installer which already adds Python to your path and installs pip, you basically only need to run
`pip install sphinx`
2.
Generate the Python documentation by running Sphinx via CMake:
```
$ mkdir -p build
$ cd build
$ cmake ..
$ make docs
```
4.
The resulting documentation will be generated in
`Documentation/html/`
[
Online documentation for Python
](
http://134.130.169.10:8080/
)
[
Online documentation for C++
](
http://134.130.169.10:8080/cxx/
)
## Copyright
2017, Institute for Automation of Complex Power Systems, EONERC
2017, Institute for Automation of Complex Power Systems, EONERC
, RWTH Aachen University
## License
...
...
Write
Preview
Supports
Markdown
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