Skip to content

Commit

Permalink
Adjust README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lisajulia committed Jan 8, 2025
1 parent fd881c8 commit 7b8b818
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Repository to host the Python documentation for OPM Flow

## Building the documentation locally
- Copy [docstrings_simulators.json](https://raw.githubusercontent.com/OPM/opm-simulators/master/python/docstrings_simulators.json) to the python folder
- Copy [docstrings_common.json](https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json) to the python folder
- Copy [dune.module](https://raw.githubusercontent.com/OPM/opm-simulators/master/dune.module) to the root folder (opm-python-documentation)
Follow the commands in .github/workflows/python_sphinx_docs.yml for your local setup!

## Building the documentation online on your fork
- Turn on github actions at `https://github.com/<your-github-username>/opm-python-documentation/actions`
Expand Down

0 comments on commit 7b8b818

Please sign in to comment.