OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-01-21 22:13:25 -06:00
Code Issues Packages Projects Releases Wiki Activity
d675db98f6
ResInsight/docs
History
Magne Sjaastad d675db98f6
Update python doc (#5803) 
Several improvement and adjustments to the Python documentation

- applied autopep8
- add summary example
- use references to reference other classes and methods
2020-04-16 16:06:18 +02:00
..
rips Update python doc (#5803) 2020-04-16 16:06:18 +02:00
source Update python doc (#5803) 2020-04-16 16:06:18 +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