- refined intro.rst and created a link to our blizzard (c) statement

ducandu · Jul 15, 2017 · 9a51953 · 9a51953
1 parent 2573326
commit 9a51953
Show file tree

Hide file tree

Showing 15 changed files with 206 additions and 188 deletions.
diff --git a/README.rst b/README.rst
@@ -75,19 +75,21 @@ This should give you a level like this:
 
 You can now control the Agent via the four arrow keys (up, down, left, right).
 
-Next steps
-----------
+Next steps and Full Documentation
+---------------------------------
 
 If you would like to create more complex levels (or entire Games with many Screens and Levels), read the
 `spygame documentation <https://sven1977.github.io/spygame/>`_, in which we'll create a full-blown 2D platformer Level
-(sorry, documentation is still very WIP!).
+(sorry about spygame's documentation still being work in progress).
+
 
 AI (Reinforcement Learning) with spygame
 ----------------------------------------
 
 I'm currently working on making spygame available as an openAI-gym Environment type, so that reinforcement learning algorithms can run against any spygame
 Level objects.
 
+
 Contribute to spygame
 ---------------------
 If you would like to contribute to the spygame library, the following items are currently open:

diff --git a/docs/_images/index_001_screenshot.png b/docs/_images/index_001_screenshot.png
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -6,12 +6,18 @@
 Welcome to spygame's documentation!
 ===================================
 
-spygame is a 2D game engine based on the python pygame module and "level-tmx" files
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+spygame is a python 2D game engine based on pygame and level-tmx files
+----------------------------------------------------------------------
+
+|
+
+.. image:: images/index_001_screenshot.png
+   :alt: Level: "We are back!"
 
 .. toctree::
    :maxdepth: 3
    :caption: Contents:
+   :numbered:
 
    readme_link.rst
    intro.rst

diff --git a/docs/adding_more_things_to_our_platformer.html b/docs/adding_more_things_to_our_platformer.html
diff --git a/docs/how_to_build_a_platformer_with_spygame.html b/docs/how_to_build_a_platformer_with_spygame.html
diff --git a/docs/how_to_code_against_spygame.html b/docs/how_to_code_against_spygame.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>How to code against spygame &#8212; spygame 0.1a9 documentation</title>
+    <title>5. How to code against spygame &#8212; spygame 0.1a9 documentation</title>
 
     <link rel="stylesheet" href="_static/spygame_sphinx.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -27,8 +27,8 @@
     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Spygame API Reference Documentation" href="spygame_reference.html" />
-    <link rel="prev" title="Adding more Things to our Platformer" href="adding_more_things_to_our_platformer.html" /> 
+    <link rel="next" title="6. Spygame API Reference Documentation" href="spygame_reference.html" />
+    <link rel="prev" title="4. Adding more Things to our Platformer" href="adding_more_things_to_our_platformer.html" /> 
   </head>
   <body>
     <div class="related" role="navigation" aria-label="related navigation">
@@ -41,10 +41,10 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="spygame_reference.html" title="Spygame API Reference Documentation"
+          <a href="spygame_reference.html" title="6. Spygame API Reference Documentation"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="adding_more_things_to_our_platformer.html" title="Adding more Things to our Platformer"
+          <a href="adding_more_things_to_our_platformer.html" title="4. Adding more Things to our Platformer"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a9 documentation</a> &#187;</li> 
       </ul>
@@ -53,10 +53,10 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <h4>Previous topic</h4>
   <p class="topless"><a href="adding_more_things_to_our_platformer.html"
-                        title="previous chapter">Adding more Things to our Platformer</a></p>
+                        title="previous chapter">4. Adding more Things to our Platformer</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="spygame_reference.html"
-                        title="next chapter">Spygame API Reference Documentation</a></p>
+                        title="next chapter">6. Spygame API Reference Documentation</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -83,7 +83,7 @@ <h3>Quick search</h3>
           <div class="body" role="main">
 
   <div class="section" id="how-to-code-against-spygame">
-<h1>How to code against spygame<a class="headerlink" href="#how-to-code-against-spygame" title="Permalink to this headline">¶</a></h1>
+<h1>5. How to code against spygame<a class="headerlink" href="#how-to-code-against-spygame" title="Permalink to this headline">¶</a></h1>
 <p>In this tutorial, we will be exploring the spygame code and learn how to write our own custom classes for spygame.</p>
 <p>[WIP]</p>
 </div>
@@ -104,10 +104,10 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="spygame_reference.html" title="Spygame API Reference Documentation"
+          <a href="spygame_reference.html" title="6. Spygame API Reference Documentation"
              >next</a> |</li>
         <li class="right" >
-          <a href="adding_more_things_to_our_platformer.html" title="Adding more Things to our Platformer"
+          <a href="adding_more_things_to_our_platformer.html" title="4. Adding more Things to our Platformer"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">spygame 0.1a9 documentation</a> &#187;</li> 
       </ul>

diff --git a/docs/images/index_001_screenshot.png b/docs/images/index_001_screenshot.png