Skip to content

Commit 0486e51

Browse files
committed
update readme
1 parent f916fce commit 0486e51

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

docs/README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
11
# ResInsight Scripting API - rips
22

3-
## Update procecure on branch next-major-release
4-
REQUIRED: Compile ResInsight and make sure the content in folder `ResInsight/GrpcInterface/Python/rips` is up to date
5-
- Checkout branch next-major-release
6-
- Delete the copy in `ResInsight-UserDocumentation/docs/rips`
7-
- Copy all files from `ResInsight/GrpcInterface/Python/rips` into `ResInsight-UserDocumentation/docs/rips`
8-
- Update the example documentation using `ResInsight-UserDocumentation/docs/source/create_python_examples.py`
9-
- See below for how to create documentation locally
10-
- Publish to branch next-major-release
11-
12-
## Release of master
13-
Create pull request from next-major-release to master branch.
3+
## Update procecure on branch next-major-release
4+
There is a workflow **update-from-latest.yml** used to update the documentation. This workflow executes the script `ResInsight-UserDocumentation/docs/source/create_python_examples.py`. This workflow will download the rips package from latest build from ResInsight main repo, build the documentation, and create a PR in this repository if required.
145

156
## How to generate documentation locally
167
- Install Python 3.x
8+
- Create a virtual environment
179
- Install dependencies for rips `pip install grpcio grpcio-tools protobuf`
1810
- Install the documentation system `pip install sphinx`
1911
- Install dependencies for sphinx `pip install m2r sphinx_rtd_theme`
2012
- Open command line in folder **docs**
21-
- Execute `make html`
22-
- Open the generated documentation in a browser `build/html/index.html`
13+
- Execute `sphinx-build -b html source build`
14+
- Open the generated documentation in a browser from this page `build/html/index.html`
15+
16+
## Release of master
17+
Create pull request from next-major-release to master branch.

0 commit comments

Comments
 (0)