Skip to content

Commit 697668c

Browse files
committed
Add changes in index.rst and confpy
1 parent 0636b30 commit 697668c

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
- '**'
77
pull_request_target:
88
types: closed
9-
branches: master
9+
branches: aritorto
1010

1111
jobs:
1212
build:
@@ -26,9 +26,9 @@ jobs:
2626
with:
2727
python-version: '3.x'
2828

29-
- name: Install compatible versions of Sphinx and Breathe
30-
run: |
31-
pip install "sphinx<7.2" breathe furo
29+
- name: Install Python packages
30+
run: |
31+
pip install sphinx==7.2.6 breathe==4.35.0 furo
3232
3333
- name: Generate Doxyfile
3434
run: |
@@ -90,6 +90,7 @@ jobs:
9090
9191
- name: Build Doxygen documentation
9292
run: |
93+
ls
9394
doxygen Doxyfile
9495
9596
- name: Build Sphinx documentation

docs/sphinx/source/conf.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,10 @@
22
import sys
33
sys.path.insert(0, os.path.abspath('.'))
44

5-
extensions = [
6-
'breathe',
7-
]
8-
5+
extensions = ['breathe']
96
breathe_projects = {
10-
"OPM": "../../doxygen/xml"
7+
'OPM': '../../doxygen/xml'
118
}
12-
breathe_default_project = "OPM"
9+
breathe_default_project = 'OPM'
1310

14-
html_theme = 'furo' # or ‘sphinc_rtd_theme’
11+
html_theme = 'furo'

docs/sphinx/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ opm-simulators documentation
55
:maxdepth: 2
66
:caption: Contents:
77

8+
89
API Reference
910
=============
1011

0 commit comments

Comments
 (0)