2020-03-20 13:01:04 -05:00
|
|
|
# ResInsight Scripting API - rips
|
|
|
|
|
|
|
|
|
|
## Please note
|
|
|
|
|
The folder **rips** is a local copy for testing purposes. We need to be able to communicate the generated files to readthedocs in some way.
|
|
|
|
|
|
2020-03-20 13:28:10 -05:00
|
|
|
## How to generate documentation locally
|
|
|
|
|
- Install Python 3.x
|
|
|
|
|
- Install dependencies for rips `pip install grpcio grpcio-tools protobuf`
|
|
|
|
|
- Install the documentation system `pip install sphinx`
|
2020-03-25 07:12:52 -05:00
|
|
|
- Install dependencies for sphinx `pip install m2r sphinx_rtd_theme`
|
2020-03-20 13:28:10 -05:00
|
|
|
- Open command line in folder **docs**
|
|
|
|
|
- Execute `make html`
|
|
|
|
|
- Open the generated documentation in a browser `build/html/index.html`
|
