<p>Philipp Deppenwiese <strong>merged</strong> this change.</p><p><a href="https://review.coreboot.org/29206">View Change</a></p><div style="white-space:pre-wrap">Approvals:
build bot (Jenkins): Verified
Paul Menzel: Looks good to me, but someone else must approve
Philipp Deppenwiese: Looks good to me, approved
Jonathan Neuschäfer: Looks good to me, but someone else must approve
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Documentation: Fix markdown inline code<br><br>recommonmark doesn't know about inline code, while all other software generating<br>documentation is able to handle it.<br>Add support for inline code by adding a wrapper class around the recommonmark<br>parser that converts code to docutils literal blocks.<br><br>Fixes invisible inline code in current documentation.<br><br>Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845<br>Signed-off-by: Patrick Rudolph <siro@das-labor.org><br>Reviewed-on: https://review.coreboot.org/29206<br>Tested-by: build bot (Jenkins) <no-reply@coreboot.org><br>Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net><br>Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net><br>Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com><br>---<br>M Documentation/conf.py<br>1 file changed, 11 insertions(+), 5 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/Documentation/conf.py b/Documentation/conf.py</span><br><span>index 07868fa..85df9ea 100644</span><br><span>--- a/Documentation/conf.py</span><br><span>+++ b/Documentation/conf.py</span><br><span>@@ -1,5 +1,6 @@</span><br><span> # -*- coding: utf-8 -*-</span><br><span> import subprocess</span><br><span style="color: hsl(120, 100%, 40%);">+from recommonmark.parser import CommonMarkParser</span><br><span> </span><br><span> # Add any paths that contain templates here, relative to this directory.</span><br><span> templates_path = ['_templates']</span><br><span>@@ -156,9 +157,14 @@</span><br><span> 'Miscellaneous'),</span><br><span> ]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-source_parsers = {</span><br><span style="color: hsl(0, 100%, 40%);">- '.md': 'recommonmark.parser.CommonMarkParser',</span><br><span style="color: hsl(0, 100%, 40%);">-}</span><br><span style="color: hsl(120, 100%, 40%);">+enable_auto_toc_tree = True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class MyCommonMarkParser(CommonMarkParser):</span><br><span style="color: hsl(120, 100%, 40%);">+ # remove this hack once upsteam RecommonMark supports inline code</span><br><span style="color: hsl(120, 100%, 40%);">+ def visit_code(self, mdnode):</span><br><span style="color: hsl(120, 100%, 40%);">+ from docutils import nodes</span><br><span style="color: hsl(120, 100%, 40%);">+ n = nodes.literal(mdnode.literal, mdnode.literal)</span><br><span style="color: hsl(120, 100%, 40%);">+ self.current_node.append(n)</span><br><span> </span><br><span> # Documents to append as an appendix to all manuals.</span><br><span> #</span><br><span>@@ -176,11 +182,11 @@</span><br><span> #</span><br><span> # texinfo_no_detailmenu = False</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-enable_auto_toc_tree = True</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> </span><br><span> def setup(app):</span><br><span> from recommonmark.transform import AutoStructify</span><br><span style="color: hsl(120, 100%, 40%);">+ app.add_source_parser('.md', MyCommonMarkParser)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> app.add_config_value('recommonmark_config', {</span><br><span> 'enable_auto_toc_tree': True,</span><br><span> 'enable_auto_doc_ref': False, # broken in Sphinx 1.6+</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/29206">change 29206</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/29206"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 </div>
<div style="display:none"> Gerrit-Change-Number: 29206 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Patrick Rudolph <siro@das-labor.org> </div>
<div style="display:none"> Gerrit-Reviewer: Angel Pons <th3fanbus@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: Jonathan Neuschäfer <j.neuschaefer@gmx.net> </div>
<div style="display:none"> Gerrit-Reviewer: Patrick Georgi <pgeorgi@google.com> </div>
<div style="display:none"> Gerrit-Reviewer: Patrick Rudolph <siro@das-labor.org> </div>
<div style="display:none"> Gerrit-Reviewer: Paul Menzel <paulepanter@users.sourceforge.net> </div>
<div style="display:none"> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: Tom Hiller <thrilleratplay@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org> </div>