<p>Patrick Rudolph has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/28427">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Documentation: Describe recommonmark's auto_toc_tree<br><br>Explain recommonmark's auto_toc_tree and give an example to make writing<br>documentation easier. Show an example what happens if the document<br>isn't included in any toctree.<br><br>Change-Id: I4938d8d292ea890caec6d396b4fa04da65e398f4<br>Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com><br>---<br>M Documentation/getting_started/writing_documentation.md<br>1 file changed, 26 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/27/28427/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md</span><br><span>index 027def9..4431cda 100644</span><br><span>--- a/Documentation/getting_started/writing_documentation.md</span><br><span>+++ b/Documentation/getting_started/writing_documentation.md</span><br><span>@@ -66,6 +66,32 @@</span><br><span>     +------------+------------+-----------+</span><br><span>     ``` #just a code block is enough</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+## TocTree</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+To make sure that all documents are included into the final documentation, you</span><br><span style="color: hsl(120, 100%, 40%);">+must reference each document from at least one *toctree*. The *toctree* must</span><br><span style="color: hsl(120, 100%, 40%);">+only reference files in the same folder or in subfolders !</span><br><span style="color: hsl(120, 100%, 40%);">+To create a toctree, simply use a bullet list or numbered list with a single</span><br><span style="color: hsl(120, 100%, 40%);">+reference. References in regular text aren't considered as *toctree* .</span><br><span style="color: hsl(120, 100%, 40%);">+This feature is enabled by recommonmark's *enable_auto_toc_tree* .</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+**Example toctree:**</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+* [Chapter 1](chapter1.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Chapter 2](chapter2.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Subchapter](sub/index.md)</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+1. [Chapter 1](chapter1.md)</span><br><span style="color: hsl(120, 100%, 40%);">+2. [Chapter 2](chapter2.md)</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If you do only reference the document, but do not include it in any toctree,</span><br><span style="color: hsl(120, 100%, 40%);">+you'll see the following warning:</span><br><span style="color: hsl(120, 100%, 40%);">+**WARNING: document isn't included in any toctree**</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> [coreboot]: https://coreboot.org</span><br><span> [Documentation]: https://review.coreboot.org/cgit/coreboot.git/tree/Documentation</span><br><span> [shpinx-autobuild]: https://github.com/GaretJax/sphinx-autobuild</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/28427">change 28427</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/28427"/><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: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I4938d8d292ea890caec6d396b4fa04da65e398f4 </div>
<div style="display:none"> Gerrit-Change-Number: 28427 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Patrick Rudolph <patrick.rudolph@9elements.com> </div>