Skip to content

Commit d8ea98c

Browse files
committed
Adds documentation for rips API
Adds a README file to the `docs` folder, outlining the update procedure for the `next-major-release` branch, conventions used in the code (specifically the use of `_internal` postfix), instructions for generating the documentation locally, and the process for releasing to the master branch.
1 parent fd36bad commit d8ea98c

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

docs/README.md

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

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.
3+
## Update Procedure for `next-major-release` Branch
4+
The workflow **update-from-latest.yml** is used to update the documentation. This workflow runs the script `docs/source/create_python_examples.py`, downloads the latest rips package from the ResInsight main repository, builds the documentation, and creates a pull request in this repository if needed.
55

6-
## How to generate documentation locally
7-
- Install Python 3.x
8-
- Create a virtual environment
9-
- Install dependencies for rips `pip install grpcio grpcio-tools protobuf`
10-
- Install the documentation system `pip install sphinx`
11-
- Install dependencies for sphinx `pip install m2r sphinx_rtd_theme`
12-
- Open command line in folder **docs**
13-
- Execute `sphinx-build -b html source build`
14-
- Open the generated documentation in a browser from this page `build/html/index.html`
6+
## Conventions
7+
We use an internal system to communicate large binary structures between Python and ResInsight. Functions related to this system are postfixed with `_internal` and are removed from the generated documentation using the script `clean_internal_methods.py`.
158

16-
## Release of master
17-
Create pull request from next-major-release to master branch.
9+
## How to Generate Documentation Locally
10+
1. Install Python 3.x
11+
2. Create a virtual environment
12+
3. Install dependencies for rips:
13+
```sh
14+
pip install grpcio grpcio-tools protobuf
15+
```
16+
4. Install Sphinx:
17+
```sh
18+
pip install sphinx
19+
```
20+
5. Install Sphinx dependencies:
21+
```sh
22+
pip install m2r sphinx_rtd_theme
23+
```
24+
6. Open a command line in the **docs** folder
25+
7. Run:
26+
```sh
27+
sphinx-build -b html source build
28+
```
29+
8. Open the generated documentation in your browser from `build/html/index.html`
30+
31+
## Releasing to Master
32+
Create a pull request from `next-major-release` to the `master` branch.

0 commit comments

Comments
 (0)