Skip to content

Commit ea0a672

Browse files
committedNov 5, 2020
conf: Reformat and back to nerv
1 parent e4d9be1 commit ea0a672

File tree

2 files changed

+20
-25
lines changed

2 files changed

+20
-25
lines changed
 

‎docs/Sphinx/conf.py

+20-24
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
import sys
1515

1616
# -- Python Bindings
17-
sys.path.insert(0, os.path.abspath('../../../projects/bindings/python/build'))
17+
sys.path.insert(0, os.path.abspath("../../../projects/bindings/python/build"))
1818

1919

2020
# -- Project information -----------------------------------------------------
2121

22-
project = 'Symengine API'
23-
copyright = '2020, SymEngine Development Team'
24-
author = 'SymEngine Development Team'
22+
project = "Symengine API"
23+
copyright = "2020, SymEngine Development Team"
24+
author = "SymEngine Development Team"
2525
master_doc = "index"
2626

2727

@@ -31,9 +31,9 @@
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
3333
extensions = [
34-
'breathe',
35-
'exhale',
36-
'myst_nb',
34+
"breathe",
35+
"exhale",
36+
"myst_nb",
3737
"sphinx_copybutton",
3838
"sphinx_togglebutton",
3939
"sphinxcontrib.bibtex",
@@ -43,7 +43,7 @@
4343
]
4444

4545
# Add any paths that contain templates here, relative to this directory.
46-
templates_path = ['_templates']
46+
templates_path = ["_templates"]
4747

4848
# List of patterns, relative to source directory, that match files and
4949
# directories to ignore when looking for source files.
@@ -63,8 +63,8 @@
6363
numfig = True
6464

6565
mathjax_config = {
66-
'extensions': ['tex2jax.js'],
67-
'jax': ['input/TeX', 'output/HTML-CSS'],
66+
"extensions": ["tex2jax.js"],
67+
"jax": ["input/TeX", "output/HTML-CSS"],
6868
}
6969

7070
# MyST and MyST-NB configuration ---------------------------------------------------
@@ -85,29 +85,27 @@
8585

8686
# -- Exhale configuration ---------------------------------------------------
8787
# Setup the breathe extension
88-
breathe_projects = {
89-
"Symengine XML": "./../Doxygen/gen_docs/xml"
90-
}
88+
breathe_projects = {"Symengine XML": "./../Doxygen/gen_docs/xml"}
9189
breathe_default_project = "Symengine XML"
9290

9391
# # Setup the exhale extension
9492
exhale_args = {
9593
# These arguments are required
96-
"containmentFolder": "./api",
97-
"rootFileName": "library_root.rst",
98-
"rootFileTitle": "Library API",
99-
"doxygenStripFromPath": "..",
94+
"containmentFolder": "./api",
95+
"rootFileName": "library_root.rst",
96+
"rootFileTitle": "Library API",
97+
"doxygenStripFromPath": "..",
10098
# Suggested optional arguments
101-
"createTreeView": True,
99+
"createTreeView": True,
102100
# TIP: if using the sphinx-bootstrap-theme, you need
103101
# "treeViewIsBootstrap": True,
104102
}
105103

106104
# Tell sphinx what the primary language being documented is.
107-
primary_domain = 'cpp'
105+
primary_domain = "cpp"
108106

109107
# Tell sphinx what the pygments highlight language should be.
110-
highlight_language = 'cpp'
108+
highlight_language = "cpp"
111109

112110
# -- Doxyrest Settings -------------------------------------------------
113111
# sys.path.insert(1, os.path.abspath('../doxyrest/sphinx'))
@@ -119,10 +117,9 @@
119117
# The theme to use for HTML and HTML Help pages. See the documentation for
120118
# a list of builtin themes.
121119
#
122-
# html_theme = 'nervproject'
120+
html_theme = "nervproject"
123121
# html_theme = 'pyramid'
124122
# html_theme = 'pydata_sphinx_theme'
125-
html_theme = 'furo'
126123
# -- Sphinx Book Theme Settings
127124
html_theme_options = {
128125
"repository_url": "https://github.com/symengine/api-docs",
@@ -132,5 +129,4 @@
132129
# Add any paths that contain custom static files (such as style sheets) here,
133130
# relative to this directory. They are copied after the builtin static files,
134131
# so a file named "default.css" will overwrite the builtin "default.css".
135-
html_static_path = ['_static']
136-
132+
html_static_path = ["_static"]

‎symeapi.yml

-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ dependencies:
1919
- exhale
2020
- sphinx-nervproject-theme
2121
- git+https://github.com/pandas-dev/pydata-sphinx-theme.git@master
22-
- furo

0 commit comments

Comments
 (0)
Please sign in to comment.