tom/ReCoDE_MCMCFF
1
0
Fork 0
mirror of https://github.com/ImperialCollegeLondon/ReCoDE_MCMCFF.git synced 2025-06-26 08:51:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add descriptions to sphinx exts + mathajax

Browse Source
This commit is contained in:
gnikit 2022-07-19 10:33:43 +01:00
parent 197a53ce3c
commit 64e2dc119c
No known key found for this signature in database
GPG Key ID: E9A03930196133F0
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/learning/09 Adding Documentation.ipynb
View File

@ -95,8 +95,10 @@
"We add the extensions by adding this to `conf.py` too:\n", "We add the extensions by adding this to `conf.py` too:\n",
"```python\n", "```python\n",
"extensions = [\n", "extensions = [\n",
" 'sphinx.ext.autodoc',\n", " 'sphinx.ext.autodoc', # for generating documentation from the docstrings in our code\n",
" 'sphinx.ext.napoleon',\n", " 'sphinx.ext.napoleon', # for parsing Numpy and Google stye docstrings\n",
" 'sphinx.ext.mathjax', # for equation rendering\n",
"\n",
"]\n", "]\n",
"```" "```"
] ]