- continuing documentation (level building tutorial)

ducandu · Jul 11, 2017 · 96ef3a1 · 96ef3a1
1 parent 18ace48
commit 96ef3a1
Show file tree

Hide file tree

Showing 22 changed files with 889 additions and 582 deletions.
diff --git a/README.rst b/README.rst
@@ -7,21 +7,18 @@ Quick Setup Instructions
 
 *All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*
 
-2D game engine based on Pygame and level-tmx files
-++++++++++++++++++++++++++++++++++++++++++++++++++
 
 Get the code
 ------------
 - You may need a pygame version that matches your python version. E.g. for Windows 10 64bit + python3.6, you can download `pygame‑1.9.3‑cp36‑cp36m‑win_amd64.whl from here <http://www.lfd.uci.edu/~gohlke/pythonlibs/#pygame>`_ and then do a ``pip install [path to downloaded wheel]``
-- Git the `spygame <www.github.com/sven1977/spygame>`_ code or do a ``pip install spygame``
+- Git the `spygame <http://github.com/sven1977/spygame>`_ code or do a ``pip install spygame``
 
 Get started
 -----------
 - write a simple game against the engine:
 
-.. highlight:: python
+.. code-block:: python
     :linenos:
-::
 
     import spygame as spyg
 
@@ -102,4 +99,7 @@ If you would like to contribute to the spygame library, the following items are
 
 .. image:: https://raw.githubusercontent.com/sven1977/spygame/master/examples/platformer_2d/screen1.png
     :alt: Lost Vikings - Sample spygame Level
+
 *All graphics are (c) Blizzard Entertainment Inc (The Lost Vikings)*
+
+
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 90c5b89abf78d44e0172710617c43c32
+config: e630411005738edaa4d2c8e99a8c2e9a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Overview: module code &#8212; spygame 0.1.0 documentation</title>
+    <title>Overview: module code &#8212; spygame 0.1a8 documentation</title>
 
     <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.1.0',
+        VERSION:     '0.1a8',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -38,7 +38,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -63,7 +63,8 @@ <h3>Quick search</h3>
 
   <h1>All modules for which code is available</h1>
 <ul><li><a href="spygame.html">spygame</a></li>
-</ul>
+<ul><li><a href="spygame/examples/vikings.html">spygame.examples.vikings</a></li>
+</ul></ul>
 
           </div>
         </div>
@@ -79,11 +80,11 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2017, Sven Mika.
+        &#169; Copyright 2017, ducandu GmbH.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
     </div>
   </body>

diff --git a/docs/_build/html/_modules/spygame.html b/docs/_build/html/_modules/spygame.html
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -6,16 +6,19 @@
 Welcome to spygame's documentation!
 ===================================
 
+spygame is a 2D game engine based on the python pygame module and "level-tmx" files
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
 .. toctree::
    :maxdepth: 3
    :caption: Contents:
 
    readme_link.rst
    intro.rst
    how_to_build_a_platformer.rst
-   spygame.rst
-   modules.rst
-   
+   how_to_code_against_spygame.rst
+   spygame_reference.rst
+
 Indices and tables
 ==================
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Welcome to spygame’s documentation! &#8212; spygame 0.1.0 documentation</title>
+    <title>Welcome to spygame’s documentation! &#8212; spygame 0.1a8 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.1.0',
+        VERSION:     '0.1a8',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -42,14 +42,17 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme_link.html" title="Quick Setup Instructions"
              accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <h3><a href="#">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">Welcome to spygame’s documentation!</a></li>
+<li><a class="reference internal" href="#">Welcome to spygame’s documentation!</a><ul>
+<li><a class="reference internal" href="#spygame-is-a-2d-game-engine-based-on-the-python-pygame-module-and-level-tmx-files">spygame is a 2D game engine based on the python pygame module and “level-tmx” files</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
 
@@ -83,18 +86,17 @@ <h3>Quick search</h3>
 
   <div class="section" id="welcome-to-spygame-s-documentation">
 <h1>Welcome to spygame’s documentation!<a class="headerlink" href="#welcome-to-spygame-s-documentation" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="spygame-is-a-2d-game-engine-based-on-the-python-pygame-module-and-level-tmx-files">
+<h2>spygame is a 2D game engine based on the python pygame module and “level-tmx” files<a class="headerlink" href="#spygame-is-a-2d-game-engine-based-on-the-python-pygame-module-and-level-tmx-files" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="readme_link.html">Quick Setup Instructions</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="readme_link.html#d-game-engine-based-on-pygame-and-level-tmx-files">2D game engine based on Pygame and level-tmx files</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="readme_link.html#get-the-code">Get the code</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme_link.html#get-started">Get started</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme_link.html#next-steps">Next steps</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme_link.html#ai-reinforcement-learning-with-spygame">AI (Reinforcement Learning) with spygame</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme_link.html#contribute-to-spygame">Contribute to spygame</a></li>
-</ul>
-</li>
+<li class="toctree-l2"><a class="reference internal" href="readme_link.html#get-the-code">Get the code</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme_link.html#get-started">Get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme_link.html#next-steps">Next steps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme_link.html#ai-reinforcement-learning-with-spygame">AI (Reinforcement Learning) with spygame</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme_link.html#contribute-to-spygame">Contribute to spygame</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to spygame</a><ul>
@@ -106,30 +108,24 @@ <h1>Welcome to spygame’s documentation!<a class="headerlink" href="#welcome-to
 <li class="toctree-l2"><a class="reference internal" href="how_to_build_a_platformer.html#level-tmx-files">Level tmx-files</a></li>
 <li class="toctree-l2"><a class="reference internal" href="how_to_build_a_platformer.html#layers">Layers</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="how_to_build_a_platformer.html#the-collision-layer">The Collision Layer</a></li>
-<li class="toctree-l3"><a class="reference internal" href="how_to_build_a_platformer.html#background-and-foreground-layers">Background and Foreground Layers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="how_to_build_a_platformer.html#the-background-layer">The Background Layer</a></li>
+<li class="toctree-l3"><a class="reference internal" href="how_to_build_a_platformer.html#the-foreground-layer">The Foreground Layer</a></li>
 <li class="toctree-l3"><a class="reference internal" href="how_to_build_a_platformer.html#the-object-layer">The Object Layer</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="how_to_build_a_platformer.html#writing-a-class-in-spygame">Writing a Class in spygame</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="spygame.html">spygame package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="spygame.html#module-spygame">Module contents</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="spygame.html#spygame-pygame-based-2d-game-engine-for-the-openai-gym">spygame (pygame based 2D game engine for the openAI gym)</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="modules.html">spygame</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="spygame.html">spygame package</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="spygame.html#module-spygame">Module contents</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="how_to_code_against_spygame.html">How to code against spygame</a></li>
+<li class="toctree-l1"><a class="reference internal" href="spygame_reference.html">Spygame API Reference Documentation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="spygame_reference.html#module-spygame">Core API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="spygame_reference.html#module-spygame.examples.vikings">Example Classes: Vikings</a></li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
+</div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
@@ -157,11 +153,11 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme_link.html" title="Quick Setup Instructions"
              >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2017, Sven Mika.
+        &#169; Copyright 2017, ducandu GmbH.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
     </div>
   </body>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Python Module Index &#8212; spygame 0.1.0 documentation</title>
+    <title>Python Module Index &#8212; spygame 0.1a8 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.1.0',
+        VERSION:     '0.1a8',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -29,10 +29,6 @@
     <link rel="search" title="Search" href="search.html" />
 
 
-    <script type="text/javascript">
-      DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
-    </script>
-
 
   </head>
   <body>
@@ -45,7 +41,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -80,9 +76,15 @@ <h1>Python Module Index</h1>
      <tr class="cap" id="cap-s"><td></td><td>
        <strong>s</strong></td><td></td></tr>
      <tr>
-       <td></td>
+       <td><img src="_static/minus.png" class="toggler"
+              id="toggle-1" style="display: none" alt="-" /></td>
        <td>
-       <a href="spygame.html#module-spygame"><code class="xref">spygame</code></a></td><td>
+       <a href="spygame_reference.html#module-spygame"><code class="xref">spygame</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="spygame_reference.html#module-spygame.examples.vikings"><code class="xref">spygame.examples.vikings</code></a></td><td>
        <em></em></td></tr>
    </table>
 
@@ -101,11 +103,11 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2017, Sven Mika.
+        &#169; Copyright 2017, ducandu GmbH.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
     </div>
   </body>

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Search &#8212; spygame 0.1.0 documentation</title>
+    <title>Search &#8212; spygame 0.1a8 documentation</title>
 
     <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.1.0',
+        VERSION:     '0.1a8',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -97,11 +97,11 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a8 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2017, Sven Mika.
+        &#169; Copyright 2017, ducandu GmbH.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
     </div>
   </body>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,9 +17,12 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../spygame'))
+sys.path.insert(0, os.path.abspath('../'))
+import spygame as spyg
 
 
 # -- General configuration ------------------------------------------------
@@ -54,17 +57,17 @@
 
 # General information about the project.
 project = 'spygame'
-copyright = '2017, Sven Mika'
+copyright = '2017, ducandu GmbH'
 author = 'Sven Mika'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = spyg.VERSION_
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = spyg.RELEASE_
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.