Accueil Explorer Aide
Connexion
Eiyeron
/
luwra
1
0
Fork 0
Files Tickets 0 Pull Requests 0 Wiki
Parcourir la Source

docs: Seperate sections

Ole il y a 9 ans
Parent
c04ec41864
commit
05a7cbfc4d
11 fichiers modifiés avec 421 ajouts et 16 suppressions
Vue séparée Afficher les stats Diff
  1. 0 0
      docs/mkdocs/advanced.md
  2. 1 1
      docs/mkdocs/basics.md
  3. 0 0
      docs/mkdocs/miscellaneous.md
  4. 173 0
      docs/output/advanced/index.html
  5. 25 7
      docs/output/basics/index.html
  6. 18 4
      docs/output/index.html
  7. 169 0
      docs/output/miscellaneous/index.html
  8. 0 1
      docs/output/mkdocs/search_index.json
  9. 15 1
      docs/output/search.html
  10. 17 1
      docs/output/sitemap.xml
  11. 3 1
      mkdocs.yml

+ 0 - 0
docs/mkdocs/advanced.md
Voir le fichier


+ 1 - 1
docs/mkdocs/usage.md → docs/mkdocs/basics.md
Voir le fichier 

@@ -1,5 +1,5 @@
 
 # Integration
 
-Luwra does not provide a standalone version of Lua nor does it capsule its features. This means that
 
+Luwra does not provide a standalone version of Lua nor does it isolate its features. This means that
 
 all functions and classes operate on
 
 [lua_State](http://www.lua.org/manual/5.3/manual.html#lua_State) (or the alias
 
 [State](/reference/namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d)). Doing this allows you to

+ 0 - 0
docs/mkdocs/miscellaneous.md
Voir le fichier


+ 173 - 0
docs/output/advanced/index.html
Voir le fichier 

@@ -0,0 +1,173 @@
 
+<!DOCTYPE html>
 
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 
+<head>
 
+  <meta charset="utf-8">
 
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
 
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
+  
+  
+  
+  <title>Advanced - Luwra</title>
 
+  
+
 
+  <link rel="shortcut icon" href="../img/favicon.ico">
 
+
 
+  
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
 
+
 
+  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
 
+  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
 
+  <link rel="stylesheet" href="../css/highlight.css">
 
+
 
+  
+  <script>
 
+    // Current page data
 
+    var mkdocs_page_name = "Advanced";
 
+    var mkdocs_page_input_path = "advanced.md";
 
+    var mkdocs_page_url = "/advanced/";
 
+  </script>
 
+  
+  <script src="../js/jquery-2.1.1.min.js"></script>
 
+  <script src="../js/modernizr-2.8.3.min.js"></script>
 
+  <script type="text/javascript" src="../js/highlight.pack.js"></script>
 
+  <script src="../js/theme.js"></script> 
+
 
+  
+</head>
 
+
 
+<body class="wy-body-for-nav" role="document">
 
+
 
+  <div class="wy-grid-for-nav">
 
+
 
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
 
+      <div class="wy-side-nav-search">
 
+        <a href=".." class="icon icon-home"> Luwra</a>
 
+        <div role="search">
 
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
 
+    <input type="text" name="q" placeholder="Search docs" />
 
+  </form>
 
+</div>
 
+      </div>
 
+
 
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
+        <ul class="current">
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="..">Home</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../basics/">Basics</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 current">
 
+        <a class="current" href="./">Advanced</a>
 
+        
+            <ul>
 
+            
+            </ul>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../miscellaneous/">Miscellaneous</a>
 
+        
+    </li>
 
+<li>
 
+          
+        </ul>
 
+      </div>
 
+      &nbsp;
 
+    </nav>
 
+
 
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
+
 
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
+        <a href="..">Luwra</a>
 
+      </nav>
 
+
 
+      
+      <div class="wy-nav-content">
 
+        <div class="rst-content">
 
+          <div role="navigation" aria-label="breadcrumbs navigation">
 
+  <ul class="wy-breadcrumbs">
 
+    <li><a href="..">Docs</a> &raquo;</li>
 
+    
+      
+    
+    <li>Advanced</li>
 
+    <li class="wy-breadcrumbs-aside">
 
+      
+        
+          <a href="https://github.com/vapourismo/luwra" class="icon icon-github"> Edit on GitHub</a>
 
+        
+      
+    </li>
 
+  </ul>
 
+  <hr/>
 
+</div>
 
+          <div role="main">
 
+            <div class="section">
 
+              
+                
+              
+            </div>
 
+          </div>
 
+          <footer>
 
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
+      
+        <a href="../miscellaneous/" class="btn btn-neutral float-right" title="Miscellaneous">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>
 
+      
+    </div>
 
+  
+
 
+  <hr/>
 
+
 
+  <div role="contentinfo">
 
+    <!-- Copyright etc -->
 
+    
+  </div>
 
+
 
+  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 
+</footer>
 
+	  
+        </div>
 
+      </div>
 
+
 
+    </section>
 
+
 
+  </div>
 
+
 
+<div class="rst-versions" role="note" style="cursor: pointer">
 
+    <span class="rst-current-version" data-toggle="rst-current-version">
 
+      
+          <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 style="margin-left: 15px"><a href="../miscellaneous/" style="color: #fcfcfc">Next &raquo;</a></span>
 
+      
+    </span>
 
+</div>
 
+
 
+</body>
 
+</html>

+ 25 - 7
docs/output/usage/index.html → docs/output/basics/index.html
Voir le fichier 

@@ -8,7 +8,7 @@
 
   
   
   
-  <title>Usage - Luwra</title>
 
+  <title>Basics - Luwra</title>
 
   
 
   <link rel="shortcut icon" href="../img/favicon.ico">
 
@@ -23,9 +23,9 @@
 
   
   <script>
 
     // Current page data
 
-    var mkdocs_page_name = "Usage";
 
-    var mkdocs_page_input_path = "usage.md";
 
-    var mkdocs_page_url = "/usage/";
 
+    var mkdocs_page_name = "Basics";
 
+    var mkdocs_page_input_path = "basics.md";
 
+    var mkdocs_page_url = "/basics/";
 
   </script>
 
   
   <script src="../js/jquery-2.1.1.min.js"></script>
 
@@ -63,7 +63,7 @@
 
           
             <li>
 
     <li class="toctree-l1 current">
 
-        <a class="current" href="./">Usage</a>
 
+        <a class="current" href="./">Basics</a>
 
         
             <ul>
 
             
@@ -84,6 +84,20 @@
 
             
             </ul>
 
         
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../advanced/">Advanced</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../miscellaneous/">Miscellaneous</a>
 
+        
     </li>
 
 <li>
 
           
@@ -109,7 +123,7 @@
 
     
       
     
-    <li>Usage</li>
 
+    <li>Basics</li>
 
     <li class="wy-breadcrumbs-aside">
 
       
         
@@ -124,7 +138,7 @@
 
             <div class="section">
 
               
                 <h1 id="integration">Integration</h1>
 
-<p>Luwra does not provide a standalone version of Lua nor does it capsule its features. This means that
 
+<p>Luwra does not provide a standalone version of Lua nor does it isolate its features. This means that
 
 all functions and classes 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
 
@@ -350,6 +364,8 @@ is delegated to the Lua VM. Have a look at the
 
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
       
+        <a href="../advanced/" class="btn btn-neutral float-right" title="Advanced">Next <span class="icon icon-circle-arrow-right"></span></a>
 
+      
       
         <a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 
       
@@ -382,6 +398,8 @@ is delegated to the Lua VM. Have a look at the
 
         <span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
 
       
       
+        <span style="margin-left: 15px"><a href="../advanced/" style="color: #fcfcfc">Next &raquo;</a></span>
 
+      
     </span>
 
 </div>

+ 18 - 4
docs/output/index.html
Voir le fichier 

@@ -73,7 +73,21 @@
 
           
             <li>
 
     <li class="toctree-l1 ">
 
-        <a class="" href="usage/">Usage</a>
 
+        <a class="" href="basics/">Basics</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="advanced/">Advanced</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="miscellaneous/">Miscellaneous</a>
 
         
     </li>
 
 <li>
 
@@ -132,7 +146,7 @@ your preference.</p>
 
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
       
-        <a href="usage/" class="btn btn-neutral float-right" title="Usage">Next <span class="icon icon-circle-arrow-right"></span></a>
 
+        <a href="basics/" class="btn btn-neutral float-right" title="Basics">Next <span class="icon icon-circle-arrow-right"></span></a>
 
       
       
     </div>
 
@@ -162,7 +176,7 @@ your preference.</p>
 
       
       
       
-        <span style="margin-left: 15px"><a href="usage/" style="color: #fcfcfc">Next &raquo;</a></span>
 
+        <span style="margin-left: 15px"><a href="basics/" style="color: #fcfcfc">Next &raquo;</a></span>
 
       
     </span>
 
 </div>
 
@@ -172,5 +186,5 @@ your preference.</p>
 
 
 <!--
 
 MkDocs version : 0.15.3
 
-Build Date UTC : 2016-04-04 22:30:43.271394
 
+Build Date UTC : 2016-04-05 12:14:37.432923
 
 -->

+ 169 - 0
docs/output/miscellaneous/index.html
Voir le fichier 

@@ -0,0 +1,169 @@
 
+<!DOCTYPE html>
 
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 
+<head>
 
+  <meta charset="utf-8">
 
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
 
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
+  
+  
+  
+  <title>Miscellaneous - Luwra</title>
 
+  
+
 
+  <link rel="shortcut icon" href="../img/favicon.ico">
 
+
 
+  
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
 
+
 
+  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
 
+  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
 
+  <link rel="stylesheet" href="../css/highlight.css">
 
+
 
+  
+  <script>
 
+    // Current page data
 
+    var mkdocs_page_name = "Miscellaneous";
 
+    var mkdocs_page_input_path = "miscellaneous.md";
 
+    var mkdocs_page_url = "/miscellaneous/";
 
+  </script>
 
+  
+  <script src="../js/jquery-2.1.1.min.js"></script>
 
+  <script src="../js/modernizr-2.8.3.min.js"></script>
 
+  <script type="text/javascript" src="../js/highlight.pack.js"></script>
 
+  <script src="../js/theme.js"></script> 
+
 
+  
+</head>
 
+
 
+<body class="wy-body-for-nav" role="document">
 
+
 
+  <div class="wy-grid-for-nav">
 
+
 
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
 
+      <div class="wy-side-nav-search">
 
+        <a href=".." class="icon icon-home"> Luwra</a>
 
+        <div role="search">
 
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
 
+    <input type="text" name="q" placeholder="Search docs" />
 
+  </form>
 
+</div>
 
+      </div>
 
+
 
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
+        <ul class="current">
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="..">Home</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../basics/">Basics</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="../advanced/">Advanced</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 current">
 
+        <a class="current" href="./">Miscellaneous</a>
 
+        
+            <ul>
 
+            
+            </ul>
 
+        
+    </li>
 
+<li>
 
+          
+        </ul>
 
+      </div>
 
+      &nbsp;
 
+    </nav>
 
+
 
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
+
 
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
+        <a href="..">Luwra</a>
 
+      </nav>
 
+
 
+      
+      <div class="wy-nav-content">
 
+        <div class="rst-content">
 
+          <div role="navigation" aria-label="breadcrumbs navigation">
 
+  <ul class="wy-breadcrumbs">
 
+    <li><a href="..">Docs</a> &raquo;</li>
 
+    
+      
+    
+    <li>Miscellaneous</li>
 
+    <li class="wy-breadcrumbs-aside">
 
+      
+        
+          <a href="https://github.com/vapourismo/luwra" class="icon icon-github"> Edit on GitHub</a>
 
+        
+      
+    </li>
 
+  </ul>
 
+  <hr/>
 
+</div>
 
+          <div role="main">
 
+            <div class="section">
 
+              
+                
+              
+            </div>
 
+          </div>
 
+          <footer>
 
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
+      
+      
+        <a href="../advanced/" class="btn btn-neutral" title="Advanced"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 
+      
+    </div>
 
+  
+
 
+  <hr/>
 
+
 
+  <div role="contentinfo">
 
+    <!-- Copyright etc -->
 
+    
+  </div>
 
+
 
+  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 
+</footer>
 
+	  
+        </div>
 
+      </div>
 
+
 
+    </section>
 
+
 
+  </div>
 
+
 
+<div class="rst-versions" role="note" style="cursor: pointer">
 
+    <span class="rst-current-version" data-toggle="rst-current-version">
 
+      
+          <a href="https://github.com/vapourismo/luwra" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
 
+      
+      
+        <span><a href="../advanced/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 
+      
+      
+    </span>
 
+</div>
 
+
 
+</body>
 
+</html>

Fichier diff supprimé car celui-ci est trop grand
+ 0 - 1
docs/output/mkdocs/search_index.json


+ 15 - 1
docs/output/search.html
Voir le fichier 

@@ -59,7 +59,21 @@
 
           
             <li>
 
     <li class="toctree-l1 ">
 
-        <a class="" href="usage/">Usage</a>
 
+        <a class="" href="basics/">Basics</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="advanced/">Advanced</a>
 
+        
+    </li>
 
+<li>
 
+          
+            <li>
 
+    <li class="toctree-l1 ">
 
+        <a class="" href="miscellaneous/">Miscellaneous</a>
 
         
     </li>
 
 <li>

+ 17 - 1
docs/output/sitemap.xml
Voir le fichier 

@@ -11,7 +11,23 @@
 
 
     
     <url>
 
-     <loc>None/usage/</loc>
 
+     <loc>None/basics/</loc>
 
+     <lastmod>2016-04-05</lastmod>
 
+     <changefreq>daily</changefreq>
 
+    </url>
 
+    
+
 
+    
+    <url>
 
+     <loc>None/advanced/</loc>
 
+     <lastmod>2016-04-05</lastmod>
 
+     <changefreq>daily</changefreq>
 
+    </url>
 
+    
+
 
+    
+    <url>
 
+     <loc>None/miscellaneous/</loc>
 
      <lastmod>2016-04-05</lastmod>
 
      <changefreq>daily</changefreq>
 
     </url>

+ 3 - 1
mkdocs.yml
Voir le fichier 

@@ -3,7 +3,9 @@ site_description: Minimal-overhead Lua wrapper for C++
 
 repo_url: https://github.com/vapourismo/luwra
 
 pages:
 
   - 'Home': index.md
 
-  - 'Usage': usage.md
 
+  - 'Basics': basics.md
 
+  - 'Advanced': advanced.md
 
+  - 'Miscellaneous': miscellaneous.md
 
 theme: readthedocs
 
 docs_dir: docs/mkdocs
 
 site_dir: docs/output

Certains fichiers n'ont pas été affichés car il y a eu trop de fichiers modifiés dans ce diff