Browse Source

docs: Make use of sub-sections

Ole 9 years ago
parent
commit
20d7c53342

+ 3 - 3
docs/mkdocs/basics.md

@@ -40,7 +40,7 @@ std::tuple<T>    | yes      | no       | *depends on the tuple contents*
 **Note:** Some numeric types have a different size than their matching Lua type - they will be
 **Note:** Some numeric types have a different size than their matching Lua type - they will be
 truncated during push or read operations.
 truncated during push or read operations.
 
 
-# Pushing C++ values
+## Pushing C++ values
 When pushing values onto the stack you can either use
 When pushing values onto the stack you can either use
 [Value<T>::push](/reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384) or the more
 [Value<T>::push](/reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384) or the more
 convenient [push](/reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa).
 convenient [push](/reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa).
@@ -71,7 +71,7 @@ Absolute Position | Relative Position | Value
 It is possible to provide a template parameter to `push` to enforce pushing a specific type.
 It is possible to provide a template parameter to `push` to enforce pushing a specific type.
 In most cases you are probably better off by letting the compiler infer the template parameter.
 In most cases you are probably better off by letting the compiler infer the template parameter.
 
 
-# Reading Lua values
+## Reading Lua values
 Simple retrieval of Lua values is done using
 Simple retrieval of Lua values is done using
 [read<T>](/reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab). Consider the
 [read<T>](/reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab). Consider the
 stack layout from the previous example. This is how you would retrieve a value from the stack.
 stack layout from the previous example. This is how you would retrieve a value from the stack.
@@ -84,7 +84,7 @@ int value = luwra::read<int>(lua, 1);
 int value = luwra::read<int>(lua, -4);
 int value = luwra::read<int>(lua, -4);
 ```
 ```
 
 
-# Read and type errors
+## Read and type errors
 What happens when a value which you are trying to read mismatches the expected type or cannot be
 What happens when a value which you are trying to read mismatches the expected type or cannot be
 converted to it? Most `Value<T>` specializations use Lua's `luaL_check*` functions to retrieve
 converted to it? Most `Value<T>` specializations use Lua's `luaL_check*` functions to retrieve
 the values from the stack. This means that no exceptions will be thrown - instead the error handling
 the values from the stack. This means that no exceptions will be thrown - instead the error handling

+ 1 - 1
docs/output/advanced/index.html

@@ -140,7 +140,7 @@ them.</p>
 <pre><code class="c++">string result = foo(luwra::read&lt;string&gt;(lua, n), luwra::read&lt;int&gt;(lua, n + 1));
 <pre><code class="c++">string result = foo(luwra::read&lt;string&gt;(lua, n), luwra::read&lt;int&gt;(lua, n + 1));
 </code></pre>
 </code></pre>
 
 
-<p>This could be rewritting like this:</p>
+<p>It could be rewritting like this:</p>
 <pre><code class="c++">string result = luwra::direct&lt;string(string, int)&gt;(lua, n, foo);
 <pre><code class="c++">string result = luwra::direct&lt;string(string, int)&gt;(lua, n, foo);
 </code></pre>
 </code></pre>
 
 

+ 6 - 9
docs/output/basics/index.html

@@ -72,14 +72,11 @@
             
             
                 <li class="toctree-l3"><a href="#stack-interaction">Stack Interaction</a></li>
                 <li class="toctree-l3"><a href="#stack-interaction">Stack Interaction</a></li>
                 
                 
-            
-                <li class="toctree-l3"><a href="#pushing-c-values">Pushing C++ values</a></li>
+                    <li><a class="toctree-l4" href="#pushing-c-values">Pushing C++ values</a></li>
                 
                 
-            
-                <li class="toctree-l3"><a href="#reading-lua-values">Reading Lua values</a></li>
+                    <li><a class="toctree-l4" href="#reading-lua-values">Reading Lua values</a></li>
                 
                 
-            
-                <li class="toctree-l3"><a href="#read-and-type-errors">Read and type errors</a></li>
+                    <li><a class="toctree-l4" href="#read-and-type-errors">Read and type errors</a></li>
                 
                 
             
             
             </ul>
             </ul>
@@ -289,7 +286,7 @@ Useful implementations are provides out of the box:</p>
 </table>
 </table>
 <p><strong>Note:</strong> Some numeric types have a different size than their matching Lua type - they will be
 <p><strong>Note:</strong> Some numeric types have a different size than their matching Lua type - they will be
 truncated during push or read operations.</p>
 truncated during push or read operations.</p>
-<h1 id="pushing-c-values">Pushing C++ values</h1>
+<h2 id="pushing-c-values">Pushing C++ values</h2>
 <p>When pushing values onto the stack you can either use
 <p>When pushing values onto the stack you can either use
 <a href="../reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384">Value&lt;T&gt;::push</a> or the more
 <a href="../reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384">Value&lt;T&gt;::push</a> or the more
 convenient <a href="../reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa">push</a>.</p>
 convenient <a href="../reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa">push</a>.</p>
@@ -340,7 +337,7 @@ luwra::push(lua, &quot;Hello World&quot;);
 </table>
 </table>
 <p>It is possible to provide a template parameter to <code>push</code> to enforce pushing a specific type.
 <p>It is possible to provide a template parameter to <code>push</code> to enforce pushing a specific type.
 In most cases you are probably better off by letting the compiler infer the template parameter.</p>
 In most cases you are probably better off by letting the compiler infer the template parameter.</p>
-<h1 id="reading-lua-values">Reading Lua values</h1>
+<h2 id="reading-lua-values">Reading Lua values</h2>
 <p>Simple retrieval of Lua values is done using
 <p>Simple retrieval of Lua values is done using
 <a href="../reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab">read&lt;T&gt;</a>. Consider the
 <a href="../reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab">read&lt;T&gt;</a>. Consider the
 stack layout from the previous example. This is how you would retrieve a value from the stack.</p>
 stack layout from the previous example. This is how you would retrieve a value from the stack.</p>
@@ -351,7 +348,7 @@ int value = luwra::read&lt;int&gt;(lua, 1);
 int value = luwra::read&lt;int&gt;(lua, -4);
 int value = luwra::read&lt;int&gt;(lua, -4);
 </code></pre>
 </code></pre>
 
 
-<h1 id="read-and-type-errors">Read and type errors</h1>
+<h2 id="read-and-type-errors">Read and type errors</h2>
 <p>What happens when a value which you are trying to read mismatches the expected type or cannot be
 <p>What happens when a value which you are trying to read mismatches the expected type or cannot be
 converted to it? Most <code>Value&lt;T&gt;</code> specializations use Lua's <code>luaL_check*</code> functions to retrieve
 converted to it? Most <code>Value&lt;T&gt;</code> specializations use Lua's <code>luaL_check*</code> functions to retrieve
 the values from the stack. This means that no exceptions will be thrown - instead the error handling
 the values from the stack. This means that no exceptions will be thrown - instead the error handling

+ 1 - 1
docs/output/index.html

@@ -186,5 +186,5 @@ your preference.</p>
 
 
 <!--
 <!--
 MkDocs version : 0.15.3
 MkDocs version : 0.15.3
-Build Date UTC : 2016-04-05 12:51:45.602562
+Build Date UTC : 2016-04-05 12:56:04.390569
 -->
 -->

File diff suppressed because it is too large
+ 0 - 0
docs/output/mkdocs/search_index.json


Some files were not shown because too many files changed in this diff