Skip to content

Commit eb01f99

Browse files
committed
[docs] Adds sphinx extensions
Steps to build the docs ```bash cd docs sphinx-apidoc -o . ../sagital_average make html python -m http.server -d _build/html# to load the automatically built documentation ```
1 parent 30a8a75 commit eb01f99

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
3333
extensions = [
34+
'sphinx.ext.autodoc', # Support automatic documentation
35+
'sphinx.ext.coverage', # Automatically check if functions are documented
36+
'sphinx.ext.mathjax', # Allow support for algebra
37+
'sphinx.ext.viewcode', # Include the source code in documentation
3438
]
3539

3640
# Add any paths that contain templates here, relative to this directory.

0 commit comments

Comments
 (0)