Test RTD markup

Author: einarf

docs/source/conf.py

@@ -21,6 +21,16 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import sphinx.environment
+from docutils.utils import get_source_line
+
+
+# Monkey patch sphinx to ignore: WARNING: nonlocal image URI
+def _warn_node(self, msg, node, **kwargs):
+    if not msg.startswith('nonlocal image URI found:'):
+        self._warnfunc(msg, '%s:%s' % get_source_line(node), **kwargs)
+
+sphinx.environment.BuildEnvironment.warn_node = _warn_node
 
 # -- General configuration ------------------------------------------------
 

docs/source/index.rst

@@ -2,13 +2,31 @@
 demosys-py documentation
 ========================
 
+demosys-py
+==========
+
+A python 3 implementation of a C++ project used to create and
+prototype demos (see
+`demoscene <https://en.wikipedia.org/wiki/Demoscene>`__) in OpenGL. The
+design of this version is heavily inspired by the
+`Django <https://www.djangoproject.com/>`__ project.
+
+This is a cross platform project that should work on OS X, Linux and Windows.
+
++-----------------+-----------------+
+| |screenshot1|   | |screenshot2|   |
++-----------------+-----------------+
+
+This was originally made for for non-interactive real time graphics
+combined with music ("real time music videos"). It's made for people who
+enjoy playing around with modern OpenGL without having to spend lots of
+time creating all the tooling to get things up and running.
 
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   intro
    quickstart
 
 
@@ -19,3 +37,7 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+
+.. |screenshot1| image:: https://objects.zetta.io:8443/v1/AUTH_06e2dbea5e824620b20b470197323277/contraz.no-static/gfx/productions/SimLife3.png
+.. |screenshot2| image:: https://objects.zetta.io:8443/v1/AUTH_06e2dbea5e824620b20b470197323277/contraz.no-static/gfx/productions/SimLife2.png

docs/source/intro.rst

@@ -2,4 +2,37 @@
 Getting Started
 ===============
 
-Quick tutorial
+Python 3
+^^^^^^^^
+
+Make sure you have Python 3 installed. On Windows and OSX you can simply install
+the latest Python 3 by downloading an installer from the official_ Python site.
+
+Note
+
+We recommend Python 3.6 or higher because of general **speed improvements** of the language,
+but Python versions down to 3.4 should work.
+
+Most linux distributions already have at least Python 3.4 installed thought `python3`.
+See documentation for your distribution on how to install a newer versions.
+
+It is common to have multiple versions of Python installed on all operating systems.
+
+Create a virualenv
+^^^^^^^^^^^^^^^^^^
+
+First of all create a directory for your project and naviagate to it using a terminal.
+We assume Python 3 here.
+
+OS X / Linux
+
+    python3.6 -m pip install virtualenv
+    python3.6 -m virtualenv env
+
+Windows
+
+    python36.exe -m pip install virtualenv
+    python36.exe -m virtualenv env
+
+
+.. _official: https://www.python.org/