OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc : Improved installation for documentation

Browse Source
This commit is contained in:
Magne Sjaastad 2020-03-20 19:28:10 +01:00
parent a3ebf3a1c1
commit 9c7e3f7568
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/README.md
View File

@ -1,8 +1,12 @@
# ResInsight Scripting API - rips
A Python interface for the ResInsight visualization and post-processing suite for Reservoir Simulations
## 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.
[Learn More](https://www.resinsight.org)
## 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`
- Open command line in folder **docs**
- Execute `make html`
- Open the generated documentation in a browser `build/html/index.html`