OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-01-21 05:53:25 -06:00
Code Issues Packages Projects Releases Wiki Activity
a7b2a28df7
ResInsight/docs
History
Gaute Lindkvist 9fcfe4fa84 Merge branch 'dev' into feature-analysis-plots-initial
2020-04-22 16:17:09 +02:00
..
rips Merge branch 'dev' into feature-analysis-plots-initial 2020-04-22 16:17:09 +02:00
source Python Doc : Avoid documenting inherited members 2020-04-17 13:54:19 +02:00
.gitignore Configuration for Sphinx 2020-03-20 19:01:04 +01:00
make.bat Configuration for Sphinx 2020-03-20 19:01:04 +01:00
README.md Update README.md 2020-03-25 13:12:52 +01:00

README.md

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.

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
  • Install dependencies for sphinx pip install m2r sphinx_rtd_theme
  • Open command line in folder docs
  • Execute make html
  • Open the generated documentation in a browser build/html/index.html