Skip to content

Commit 15d8e3d

Browse files
committed
add autodoc to packge conf.py files
1 parent 38cfb4c commit 15d8e3d

File tree

6 files changed

+24
-0
lines changed

6 files changed

+24
-0
lines changed

doc/arkode/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

doc/cvode/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

doc/cvodes/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

doc/ida/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

doc/idas/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

doc/kinsol/guide/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
sys.path.append(os.path.dirname(os.path.abspath("../../../shared")))
1919

20+
# Add suntools directory to import python function docstings with autodoc
21+
sys.path.append(os.path.abspath("../../../../tools/suntools"))
22+
2023
# -- General configuration ----------------------------------------------------
2124

2225
# Set variable used to determine which package documentation this is
@@ -37,6 +40,7 @@
3740
"sphinxcontrib.bibtex",
3841
"sphinx_copybutton",
3942
"sphinx_sundials",
43+
"sphinx.ext.autodoc",
4044
]
4145

4246
intersphinx_mapping = {

0 commit comments

Comments
 (0)