Disable math on builds to fix doc building

This commit is contained in:
Eric Holscher 2019-08-09 11:37:09 -07:00
parent 48f9d1a684
commit 5a14811519
2 changed files with 8 additions and 0 deletions

View file

@ -134,6 +134,8 @@ def function():
### Math Formula
You can normally write latex math formula with `math` codeblock. See also [Inline Math](#inline-math).
**Warning**: Math is currently broken on some Sphinx builds
Example
````
@ -149,6 +151,7 @@ E = m c^2
```
### Embed reStructuredText
Recommonmark also allows embedding reStructuredText syntax in the codeblocks.
There are two styles for embedding reStructuredText. The first is enabled by `eval_rst` codeblock. The content of codeblock will be parsed as reStructuredText and insert into the document. This can be used to quickly introduce some of reStructuredText command that not yet available in markdown. For example,
@ -243,11 +246,14 @@ The `<div style="clear: right;"></div>` line clears the sidebar for the next tit
Inline Math
-----------
Besides the [Math Formula](#math-formula), you can also write latex math in inline codeblock text. You can do so by inserting `$`
in the beginning and end of inline codeblock.
Example
**Warning**: Math is currently broken on some Sphinx builds
```
This formula `$ y=\sum_{i=1}^n g(x_i) $`
```

View file

@ -295,6 +295,8 @@ def setup(app):
app.add_config_value('recommonmark_config', {
#'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
'enable_math': False,
'enable_inline_math': False,
'enable_eval_rst': True,
'enable_auto_doc_ref': True,
}, True)