Bladeren bron

docs: Move 'Reference Manual' to index.md

Ole 9 jaren geleden
bovenliggende
commit
f2ed7cb07d

+ 3 - 1
docs/mkdocs/index.md

@@ -1,5 +1,4 @@
 # 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
@@ -10,3 +9,6 @@ For your application to be able to reach the `lib/luwra.hpp` header file, you mu
 `-I/path/to/luwra/lib` command-line parameter.
 
 Now you can simply `#include <luwra.hpp>` in your C++ files and start using Luwra.
+
+# Reference Manual
+A reference manual exists [here](/reference/).

+ 0 - 3
docs/mkdocs/usage.md

@@ -1,3 +0,0 @@
-# Reference Manual
-
-A reference manual exists [here](/reference/).

+ 6 - 17
docs/output/index.html

@@ -63,15 +63,11 @@
                 <li class="toctree-l3"><a href="#installation">Installation</a></li>
                 
             
+                <li class="toctree-l3"><a href="#reference-manual">Reference Manual</a></li>
+                
+            
             </ul>
         
-    </li>
-<li>
-          
-            <li>
-    <li class="toctree-l1 ">
-        <a class="" href="usage/">Usage</a>
-        
     </li>
 <li>
           
@@ -120,18 +116,13 @@ your preference.</p>
 <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="reference-manual">Reference Manual</h1>
+<p>A reference manual exists <a href="./reference/">here</a>.</p>
               
             </div>
           </div>
           <footer>
   
-    <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>
-      
-      
-    </div>
-  
 
   <hr/>
 
@@ -157,8 +148,6 @@ your preference.</p>
       
       
       
-        <span style="margin-left: 15px"><a href="usage/" style="color: #fcfcfc">Next &raquo;</a></span>
-      
     </span>
 </div>
 
@@ -167,5 +156,5 @@ your preference.</p>
 
 <!--
 MkDocs version : 0.15.3
-Build Date UTC : 2016-03-30 16:10:23.502886
+Build Date UTC : 2016-03-30 16:11:56.533589
 -->

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


+ 0 - 7
docs/output/search.html

@@ -54,13 +54,6 @@
     <li class="toctree-l1 ">
         <a class="" href=".">Home</a>
         
-    </li>
-<li>
-          
-            <li>
-    <li class="toctree-l1 ">
-        <a class="" href="usage/">Usage</a>
-        
     </li>
 <li>
           

+ 0 - 8
docs/output/sitemap.xml

@@ -9,12 +9,4 @@
     </url>
     
 
-    
-    <url>
-     <loc>None/usage/</loc>
-     <lastmod>2016-03-30</lastmod>
-     <changefreq>daily</changefreq>
-    </url>
-    
-
 </urlset>

+ 0 - 159
docs/output/usage/index.html

@@ -1,159 +0,0 @@
-<!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>Usage - 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 = "Usage";
-    var mkdocs_page_input_path = "usage.md";
-    var mkdocs_page_url = "/usage/";
-  </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 current">
-        <a class="current" href="./">Usage</a>
-        
-            <ul>
-            
-                <li class="toctree-l3"><a href="#reference-manual">Reference Manual</a></li>
-                
-            
-            </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>Usage</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">
-              
-                <h1 id="reference-manual">Reference Manual</h1>
-<p>A reference manual exists <a href="../reference/">here</a>.</p>
-              
-            </div>
-          </div>
-          <footer>
-  
-    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-      
-      
-        <a href=".." class="btn btn-neutral" title="Home"><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=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
-      
-      
-    </span>
-</div>
-
-</body>
-</html>

+ 0 - 1
mkdocs.yml

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

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