diff --git a/docs/README.md b/docs/README.md index 532887e9d9..b1fb9958e0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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`