File tree 4 files changed +15
-8
lines changed
4 files changed +15
-8
lines changed Original file line number Diff line number Diff line change @@ -151,6 +151,8 @@ jobs:
151
151
shell : bash
152
152
run : |
153
153
source bin/test_symengine_unix.sh
154
+ pip install sphinx m2r2 sphinx-autodoc2 sphinx-book-theme
155
+ sphinx-build docs/ genDocs
154
156
env :
155
157
PYTEST_ADDOPTS : ${{ matrix.PYTEST_ADDOPTS }}
156
158
USE_GLIBCXX_DEBUG : ${{ matrix.USE_GLIBCXX_DEBUG }}
@@ -185,6 +187,12 @@ jobs:
185
187
BUILD_SHARED_LIBS : ${{ matrix.BUILD_SHARED_LIBS }}
186
188
PYTHON_VERSION : ${{ matrix.PYTHON_VERSION }}
187
189
190
+ - name : Generate documentation
191
+ shell : bash
192
+ run : |
193
+ pip install sphinx m2r2 sphinx-autodoc2 sphinx-book-theme
194
+ sphinx-build docs/ genDocs
195
+
188
196
- name : Deploy Documentation
189
197
if : ${{ (github.ref == 'refs/heads/main' && github.repository == 'Symengine/symengine.py') || (github.ref == 'refs/heads/master' && github.repository == 'Symengine/symengine.py')}}
190
198
uses : peaceiris/actions-gh-pages@v3
Original file line number Diff line number Diff line change @@ -19,4 +19,3 @@ source bin/install_travis.sh
19
19
# Build Python wrappers and test
20
20
cd $PYTHON_SOURCE_DIR
21
21
bin/test_travis.sh
22
-
Original file line number Diff line number Diff line change 17
17
import os
18
18
import sys
19
19
20
- sys .path .insert (0 , os .path .abspath (".." ))
21
-
22
- import symengine
23
-
24
20
# -- Project information -----------------------------------------------------
25
21
26
22
project = 'symengine'
27
23
copyright = '2021, SymEngine development team <[email protected] >'
28
24
author = 'SymEngine development team <[email protected] >'
29
25
30
26
# The full version, including alpha/beta/rc tags
31
- release = symengine .__version__
27
+ # release = symengine.__version__
32
28
33
29
34
30
# -- General configuration ---------------------------------------------------
46
42
"sphinx.ext.duration" , # Shows times in the processing pipeline
47
43
"sphinx.ext.mathjax" , # Need math support
48
44
"sphinx.ext.githubpages" , # Puts the .nojekyll and CNAME files
49
- "sphinxcontrib.apidoc" , # Automatically sets up sphinx-apidoc
50
45
# "recommonmark", # Parses markdown
51
46
"m2r2" , # Parses markdown in rst
47
+ "autodoc2" ,
48
+ ]
49
+
50
+ autodoc2_packages = [
51
+ "../symengine" ,
52
52
]
53
53
54
54
# Add any paths that contain templates here, relative to this directory.
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ Symengine Python API Documentation
10
10
:maxdepth: 2
11
11
:caption: Contents:
12
12
13
- source/modules
13
+ apidocs/index
14
14
15
15
.. mdinclude :: ../README.md
16
16
You can’t perform that action at this time.
0 commit comments