Added sphinx documentation for Python bindings

Added sphinx documentation for the opm.simulators.BlackOilSimulator
Python module. Added GitHub action workflow to deploy sphinx
documentation to GitHub Pages.
This commit is contained in:
Håkon Hægland
2024-05-14 09:00:52 +02:00
parent 2e7a7a0c44
commit 566a844fef
12 changed files with 789 additions and 1 deletions
+23
View File
@@ -0,0 +1,23 @@
# Python scripts for building opm-simulators sphinx documentation
## Installation of the python scripts
- Requires python3 >= 3.10
### Using poetry
For development it is recommended to use poetry:
- Install [poetry](https://python-poetry.org/docs/)
- Then run:
```
$ poetry install
$ poetry shell
```
### Installation into virtual environment
If you do not plan to change the code, you can do a regular installation into a VENV:
```
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install .
```