Skip to content

Commit

Permalink
Merge pull request readthedocs#171 from readthedocs/fix-doc-builds
Browse files Browse the repository at this point in the history
Disable math on builds to fix doc building
  • Loading branch information
ericholscher authored Aug 9, 2019
2 parents 48f9d1a + 9868c77 commit ddd56e7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/auto_structify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

````
Expand All @@ -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,

Expand Down Expand Up @@ -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) $`
```
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit ddd56e7

Please sign in to comment.