Преглед на файлове

docs: Rearrange section 'Basics' and 'Home'

Ole преди 9 години
родител
ревизия
ddea2aa7cd

+ 15 - 4
docs/mkdocs/index.md

@@ -1,8 +1,8 @@
 # Installation
 Luwra is a header-only library, which means that nothing has to be compiled in order to use it.
-Simply clone the [repository](https://github.com/vapourismo/luwra) or
-[download](https://github.com/vapourismo/luwra/archive/master.zip) and extract it to a directory of
-your preference.
+Simply clone the [repository][luwra-repo] or
+[download][luwra-download] it and extract it to a directory
+of your preference.
 
 For your application to be able to reach the `lib/luwra.hpp` header file, you must add
 `/path/to/luwra/lib` to the list of include paths. With Clang and GCC that is done using the
@@ -10,5 +10,16 @@ For your application to be able to reach the `lib/luwra.hpp` header file, you mu
 
 Now you can simply `#include <luwra.hpp>` in your C++ files and start using Luwra.
 
+# Integration
+This library does not provide a standalone version of Lua nor does it isolate its features. This
+means that all functions and classes can operate on [lua_State][lua-state] (or the alias
+[State][luwra-state]). Doing this allows you to integrate Luwra however you like.
+
 # Reference Manual
-A reference manual exists [here](/reference/namespaceluwra.html).
+A reference manual exists [here][luwra-refmanual].
+
+[lua-state]: http://www.lua.org/manual/5.3/manual.html#lua_State
+[luwra-refmanual]: /reference/namespaceluwra.html
+[luwra-repo]: https://github.com/vapourismo/luwra
+[luwra-download]: https://github.com/vapourismo/luwra/archive/master.zip
+[luwra-state]: /reference/namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d

+ 8 - 27
docs/mkdocs/basics.md → docs/mkdocs/stack-interaction.md

@@ -1,12 +1,7 @@
-# Integration
-Luwra does not provide a standalone version of Lua nor does it isolate its features. This means that
-all functions and classes can operate on [lua_State][lua-state] (or the alias [State][luwra-state]).
-Doing this allows you to integrate Luwra however you like.
-
-# Stack Interaction
-A fundamental aspect of this is the abstract template [Value][luwra-value].
-Every type which can be pushed onto or read from the stack has a specialization of it.
-Useful implementations are provided out of the box:
+# Stack interaction
+A fundamental aspect of this is the abstract template [Value][luwra-value]. Every type which can be
+pushed onto or read from the stack has a specialization of it. Useful implementations are provided
+out of the box:
 
 C++ type                               | Pushable | Readable | Lua type
 ---------------------------------------|----------|----------|----------------------------
@@ -88,8 +83,9 @@ luwra::push(lua, luwra::MemberMap {
 });
 ```
 
-**Note:** `luwra::MemberMap` is an alias for `std:map<luwra::Pushable, luwra::Pushable>`. Its keys
-and values are constructible using any pushable type.
+**Note:** [luwra::MemberMap][luwra-membermap] is an alias for
+`std:map<luwra::Pushable, luwra::Pushable>`. Its keys and values are constructible using any
+pushable type.
 
 This produces the following stack layout:
 
@@ -123,27 +119,12 @@ the stack. This means that no exceptions will be thrown - instead the error hand
 the Lua VM. Have a look at the [error handling documentation][lua-errorhandling] for more
 information.
 
-# Globals
-In order to conveniently register values in the global namespace, Luwra provides
-[setGlobal][luwra-setglobal] and [getGlobal][luwra-global].
-
-```c++
-// Register in the global namespace
-luwra::setGlobal(lua, "almostPi", 3.14);
-
-// Retrieve from globals
-double almostPi = luwra::getGlobal<double>(lua, "almostPi");
-```
-
-[lua-state]: http://www.lua.org/manual/5.3/manual.html#lua_State
 [lua-cfunction]: http://www.lua.org/manual/5.3/manual.html#lua_CFunction
 [lua-errorhandling]: http://www.lua.org/manual/5.3/manual.html#4.6
-[luwra-state]: /reference/namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d
 [luwra-value]: /reference/structluwra_1_1Value.html
 [luwra-nativefunction]: /reference/structluwra_1_1NativeFunction_3_01R_07A_8_8_8_08_4.html
 [luwra-table]: /reference/structluwra_1_1Table.html
 [luwra-read]: /reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab
 [luwra-value-push]: /reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384
 [luwra-push]: /reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa
-[luwra-setglobal]: /reference/namespaceluwra.html#afed27900ff117638937ad92e0217258d
-[luwra-getglobal]: /reference/namespaceluwra.html#af0a7dbbbdb339227c6ecaaa46422e05b
+[luwra-membermap]: /reference/namespaceluwra.html#a2e12e40b973f0f56cb9a1dc91bef882a

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

@@ -63,7 +63,7 @@
           
             <li>
     <li class="toctree-l1 ">
-        <a class="" href="../basics/">Basics</a>
+        <a class="" href="../stack-interaction/">Stack Interaction</a>
         
     </li>
 <li>
@@ -179,7 +179,7 @@ function&lt;string(string, int)&gt; foo = /* magic */;
         <a href="../wrapping/" class="btn btn-neutral float-right" title="Wrapping">Next <span class="icon icon-circle-arrow-right"></span></a>
       
       
-        <a href="../basics/" class="btn btn-neutral" title="Basics"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../stack-interaction/" class="btn btn-neutral" title="Stack Interaction"><span class="icon icon-circle-arrow-left"></span> Previous</a>
       
     </div>
   
@@ -207,7 +207,7 @@ function&lt;string(string, int)&gt; foo = /* magic */;
           <a href="https://github.com/vapourismo/luwra" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
       
       
-        <span><a href="../basics/" style="color: #fcfcfc;">&laquo; Previous</a></span>
+        <span><a href="../stack-interaction/" style="color: #fcfcfc;">&laquo; Previous</a></span>
       
       
         <span style="margin-left: 15px"><a href="../wrapping/" style="color: #fcfcfc">Next &raquo;</a></span>

+ 13 - 6
docs/output/index.html

@@ -63,6 +63,9 @@
                 <li class="toctree-l3"><a href="#installation">Installation</a></li>
                 
             
+                <li class="toctree-l3"><a href="#integration">Integration</a></li>
+                
+            
                 <li class="toctree-l3"><a href="#reference-manual">Reference Manual</a></li>
                 
             
@@ -73,7 +76,7 @@
           
             <li>
     <li class="toctree-l1 ">
-        <a class="" href="basics/">Basics</a>
+        <a class="" href="stack-interaction/">Stack Interaction</a>
         
     </li>
 <li>
@@ -138,12 +141,16 @@
                 <h1 id="installation">Installation</h1>
 <p>Luwra is a header-only library, which means that nothing has to be compiled in order to use it.
 Simply clone the <a href="https://github.com/vapourismo/luwra">repository</a> or
-<a href="https://github.com/vapourismo/luwra/archive/master.zip">download</a> and extract it to a directory of
-your preference.</p>
+<a href="https://github.com/vapourismo/luwra/archive/master.zip">download</a> it and extract it to a directory
+of your preference.</p>
 <p>For your application to be able to reach the <code>lib/luwra.hpp</code> header file, you must add
 <code>/path/to/luwra/lib</code> to the list of include paths. With Clang and GCC that is done using the
 <code>-I/path/to/luwra/lib</code> command-line parameter.</p>
 <p>Now you can simply <code>#include &lt;luwra.hpp&gt;</code> in your C++ files and start using Luwra.</p>
+<h1 id="integration">Integration</h1>
+<p>This library does not provide a standalone version of Lua nor does it isolate its features. This
+means that all functions and classes can operate on <a href="http://www.lua.org/manual/5.3/manual.html#lua_State">lua_State</a> (or the alias
+<a href="./reference/namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a>). Doing this allows you to integrate Luwra however you like.</p>
 <h1 id="reference-manual">Reference Manual</h1>
 <p>A reference manual exists <a href="./reference/namespaceluwra.html">here</a>.</p>
               
@@ -153,7 +160,7 @@ your preference.</p>
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="basics/" class="btn btn-neutral float-right" title="Basics">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="stack-interaction/" class="btn btn-neutral float-right" title="Stack Interaction">Next <span class="icon icon-circle-arrow-right"></span></a>
       
       
     </div>
@@ -183,7 +190,7 @@ your preference.</p>
       
       
       
-        <span style="margin-left: 15px"><a href="basics/" style="color: #fcfcfc">Next &raquo;</a></span>
+        <span style="margin-left: 15px"><a href="stack-interaction/" style="color: #fcfcfc">Next &raquo;</a></span>
       
     </span>
 </div>
@@ -193,5 +200,5 @@ your preference.</p>
 
 <!--
 MkDocs version : 0.15.3
-Build Date UTC : 2016-05-20 20:49:36.625613
+Build Date UTC : 2016-05-21 15:22:08.371518
 -->

Файловите разлики са ограничени, защото са твърде много
+ 0 - 0
docs/output/mkdocs/search_index.json


+ 1 - 1
docs/output/search.html

@@ -59,7 +59,7 @@
           
             <li>
     <li class="toctree-l1 ">
-        <a class="" href="basics/">Basics</a>
+        <a class="" href="stack-interaction/">Stack Interaction</a>
         
     </li>
 <li>

+ 6 - 6
docs/output/sitemap.xml

@@ -4,15 +4,15 @@
     
     <url>
      <loc>None/</loc>
-     <lastmod>2016-05-20</lastmod>
+     <lastmod>2016-05-21</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
 
     
     <url>
-     <loc>None/basics/</loc>
-     <lastmod>2016-05-20</lastmod>
+     <loc>None/stack-interaction/</loc>
+     <lastmod>2016-05-21</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -20,7 +20,7 @@
     
     <url>
      <loc>None/advanced/</loc>
-     <lastmod>2016-05-20</lastmod>
+     <lastmod>2016-05-21</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -28,7 +28,7 @@
     
     <url>
      <loc>None/wrapping/</loc>
-     <lastmod>2016-05-20</lastmod>
+     <lastmod>2016-05-21</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -36,7 +36,7 @@
     
     <url>
      <loc>None/user-types/</loc>
-     <lastmod>2016-05-20</lastmod>
+     <lastmod>2016-05-21</lastmod>
      <changefreq>daily</changefreq>
     </url>
     

+ 14 - 32
docs/output/basics/index.html → docs/output/stack-interaction/index.html

@@ -8,7 +8,7 @@
   
   
   
-  <title>Basics - Luwra</title>
+  <title>Stack Interaction - Luwra</title>
   
 
   <link rel="shortcut icon" href="../img/favicon.ico">
@@ -23,9 +23,9 @@
   
   <script>
     // Current page data
-    var mkdocs_page_name = "Basics";
-    var mkdocs_page_input_path = "basics.md";
-    var mkdocs_page_url = "/basics/";
+    var mkdocs_page_name = "Stack Interaction";
+    var mkdocs_page_input_path = "stack-interaction.md";
+    var mkdocs_page_url = "/stack-interaction/";
   </script>
   
   <script src="../js/jquery-2.1.1.min.js"></script>
@@ -63,14 +63,11 @@
           
             <li>
     <li class="toctree-l1 current">
-        <a class="current" href="./">Basics</a>
+        <a class="current" href="./">Stack Interaction</a>
         
             <ul>
             
-                <li class="toctree-l3"><a href="#integration">Integration</a></li>
-                
-            
-                <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><a class="toctree-l4" href="#extending-supported-types">Extending supported types</a></li>
                 
@@ -81,9 +78,6 @@
                     <li><a class="toctree-l4" href="#read-and-type-errors">Read and type errors</a></li>
                 
             
-                <li class="toctree-l3"><a href="#globals">Globals</a></li>
-                
-            
             </ul>
         
     </li>
@@ -132,7 +126,7 @@
     
       
     
-    <li>Basics</li>
+    <li>Stack Interaction</li>
     <li class="wy-breadcrumbs-aside">
       
         
@@ -146,14 +140,10 @@
           <div role="main">
             <div class="section">
               
-                <h1 id="integration">Integration</h1>
-<p>Luwra does not provide a standalone version of Lua nor does it isolate its features. This means that
-all functions and classes can operate on <a href="http://www.lua.org/manual/5.3/manual.html#lua_State">lua_State</a> (or the alias <a href="../reference/namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a>).
-Doing this allows you to integrate Luwra however you like.</p>
-<h1 id="stack-interaction">Stack Interaction</h1>
-<p>A fundamental aspect of this is the abstract template <a href="../reference/structluwra_1_1Value.html">Value</a>.
-Every type which can be pushed onto or read from the stack has a specialization of it.
-Useful implementations are provided out of the box:</p>
+                <h1 id="stack-interaction">Stack interaction</h1>
+<p>A fundamental aspect of this is the abstract template <a href="../reference/structluwra_1_1Value.html">Value</a>. Every type which can be
+pushed onto or read from the stack has a specialization of it. Useful implementations are provided
+out of the box:</p>
 <table>
 <thead>
 <tr>
@@ -358,8 +348,9 @@ luwra::push(lua, luwra::MemberMap {
 });
 </code></pre>
 
-<p><strong>Note:</strong> <code>luwra::MemberMap</code> is an alias for <code>std:map&lt;luwra::Pushable, luwra::Pushable&gt;</code>. Its keys
-and values are constructible using any pushable type.</p>
+<p><strong>Note:</strong> <a href="../reference/namespaceluwra.html#a2e12e40b973f0f56cb9a1dc91bef882a">luwra::MemberMap</a> is an alias for
+<code>std:map&lt;luwra::Pushable, luwra::Pushable&gt;</code>. Its keys and values are constructible using any
+pushable type.</p>
 <p>This produces the following stack layout:</p>
 <table>
 <thead>
@@ -415,15 +406,6 @@ int value = luwra::read&lt;int&gt;(lua, -5);
 the stack. This means that no exceptions will be thrown - instead the error handling is delegated to
 the Lua VM. Have a look at the <a href="http://www.lua.org/manual/5.3/manual.html#4.6">error handling documentation</a> for more
 information.</p>
-<h1 id="globals">Globals</h1>
-<p>In order to conveniently register values in the global namespace, Luwra provides
-<a href="../reference/namespaceluwra.html#afed27900ff117638937ad92e0217258d">setGlobal</a> and [getGlobal][luwra-global].</p>
-<pre><code class="c++">// Register in the global namespace
-luwra::setGlobal(lua, &quot;almostPi&quot;, 3.14);
-
-// Retrieve from globals
-double almostPi = luwra::getGlobal&lt;double&gt;(lua, &quot;almostPi&quot;);
-</code></pre>
               
             </div>
           </div>

+ 1 - 1
docs/output/user-types/index.html

@@ -63,7 +63,7 @@
           
             <li>
     <li class="toctree-l1 ">
-        <a class="" href="../basics/">Basics</a>
+        <a class="" href="../stack-interaction/">Stack Interaction</a>
         
     </li>
 <li>

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

@@ -63,7 +63,7 @@
           
             <li>
     <li class="toctree-l1 ">
-        <a class="" href="../basics/">Basics</a>
+        <a class="" href="../stack-interaction/">Stack Interaction</a>
         
     </li>
 <li>

+ 1 - 1
mkdocs.yml

@@ -3,7 +3,7 @@ site_description: Minimal-overhead Lua wrapper for C++
 repo_url: https://github.com/vapourismo/luwra
 pages:
   - 'Home': index.md
-  - 'Basics': basics.md
+  - 'Stack Interaction': stack-interaction.md
   - 'Advanced Stack Interaction': advanced.md
   - 'Wrapping': wrapping.md
   - 'User Types': user-types.md

Някои файлове не бяха показани, защото твърде много файлове са промени