Skip to content

Commit 86ef61a

Browse files
[CONFIG] tweaks to sphinx config
1 parent aa5e9ff commit 86ef61a

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/conf.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,23 @@
2727

2828
# Add any Sphinx extension module names here, as strings. They can be extensions
2929
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30-
extensions = []
30+
extensions = [
31+
'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.githubpages',
32+
'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'sphinx.ext.todo',
33+
'sphinx.ext.linkcode', 'sphinx.ext.viewcode'
34+
]
3135

3236
# Add any paths that contain templates here, relative to this directory.
3337
templates_path = ['_templates']
3438

3539
# The suffix of source filenames.
36-
source_suffix = '.md'
40+
source_suffix = {
41+
'.rst': 'restructuredtext',
42+
'.md': 'markdown',
43+
}
3744

38-
# The encoding of source files.
39-
source_encoding = 'utf-8'
45+
# The encoding of source files. Official sphinx docs reccomend utf-8-sig.
46+
source_encoding = 'utf-8-sig'
4047

4148
# The master toctree document.
4249
master_doc = 'index'

0 commit comments

Comments
 (0)