From 5a14811519a219b88c96b5b9bc3103ce5d758dc4 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Fri, 9 Aug 2019 11:37:09 -0700 Subject: [PATCH 1/2] Disable math on builds to fix doc building --- docs/auto_structify.md | 6 ++++++ docs/conf.py | 2 ++ 2 files changed, 8 insertions(+) diff --git a/docs/auto_structify.md b/docs/auto_structify.md index 52eba2e..c4d58e5 100644 --- a/docs/auto_structify.md +++ b/docs/auto_structify.md @@ -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 `
` 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) $` ``` diff --git a/docs/conf.py b/docs/conf.py index 5c2f8c1..a67cc99 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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) From 9868c77bd8954251880387cb8fc80fcf9c43f58a Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Fri, 9 Aug 2019 11:38:52 -0700 Subject: [PATCH 2/2] Small change --- docs/auto_structify.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/auto_structify.md b/docs/auto_structify.md index c4d58e5..409f176 100644 --- a/docs/auto_structify.md +++ b/docs/auto_structify.md @@ -134,7 +134,7 @@ 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 +**Warning**: Math is currently broken on some Sphinx builds. Example @@ -252,7 +252,7 @@ in the beginning and end of inline codeblock. Example -**Warning**: Math is currently broken on some Sphinx builds +**Warning**: Math is currently broken on some Sphinx builds. ``` This formula `$ y=\sum_{i=1}^n g(x_i) $`