Skip to content
This repository was archived by the owner on Mar 25, 2022. It is now read-only.

Commit 5a14811

Browse files
committed
Disable math on builds to fix doc building
1 parent 48f9d1a commit 5a14811

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/auto_structify.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ def function():
134134
### Math Formula
135135
You can normally write latex math formula with `math` codeblock. See also [Inline Math](#inline-math).
136136

137+
**Warning**: Math is currently broken on some Sphinx builds
138+
137139
Example
138140

139141
````
@@ -149,6 +151,7 @@ E = m c^2
149151
```
150152

151153
### Embed reStructuredText
154+
152155
Recommonmark also allows embedding reStructuredText syntax in the codeblocks.
153156
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,
154157

@@ -243,11 +246,14 @@ The `<div style="clear: right;"></div>` line clears the sidebar for the next tit
243246

244247
Inline Math
245248
-----------
249+
246250
Besides the [Math Formula](#math-formula), you can also write latex math in inline codeblock text. You can do so by inserting `$`
247251
in the beginning and end of inline codeblock.
248252

249253
Example
250254

255+
**Warning**: Math is currently broken on some Sphinx builds
256+
251257
```
252258
This formula `$ y=\sum_{i=1}^n g(x_i) $`
253259
```

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ def setup(app):
295295
app.add_config_value('recommonmark_config', {
296296
#'url_resolver': lambda url: github_doc_root + url,
297297
'auto_toc_tree_section': 'Contents',
298+
'enable_math': False,
299+
'enable_inline_math': False,
298300
'enable_eval_rst': True,
299301
'enable_auto_doc_ref': True,
300302
}, True)

0 commit comments

Comments
 (0)