Update the documentation index

Author: NicholasMamo

docs/.doctrees/environment.pickle

@@ -56,6 +56,9 @@ Why Multiplex?
 
 	If Multiplex is based on matplotlib, why not use matplotlib directly?
 
+.. image:: ../examples/exports/0-multiplex-dark-style.png
+   :class: example
+
 Multiplex does not replace matplotlib.
 Anything that you can do with Multiplex, you can also do with matplotlib.
 What Multiplex does is make it easier to create beautiful visualizations.
@@ -73,18 +76,23 @@ For example, you can create a text visualization with a simple function call, in
 	import matplotlib.pyplot as plt
 	from multiplex import drawable
 	plt.style.use(os.path.join(sys.path[0], '..', 'styles', "multiplex.style"))
-	viz = drawable.Drawable(plt.figure(figsize=(10, 1)))
-	text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
-	viz.draw_text_annotation(text, align='justify', fontfamily='serif', fontsize='large', lpad=0.1, rpad=0.1)
-	viz.set_title('Text visualization', loc='left')
-	viz.set_caption("It doesn't take much to create text visualizations with Multiplex!")
+	viz = drawable.Drawable(plt.figure(figsize=(10, 2)))
+	paragraph = """Anthony Lopes is a Portuguese professional footballer who plays for Olympique Lyonnais as a goalkeeper. He came through the youth ranks at Lyon, being called to the first team in 2011 and making his debut the following year."""
+	style = { 'align': 'justify', 'fontfamily': 'serif', 'alpha': 0.9, 'lineheight': 1.25, 'lpad': 0.1, 'rpad': 0.1 }
+	viz.draw_text_annotation(paragraph, **style)
+	viz.set_title('Profile: Anthony Lopes', loc='left')
+	viz.set_caption("""Wikipedia is a useful repository to get more information about anything. Below is an excerpt from the Wikipedia profile of footballer Anthony Lopes.""")
 	plt.show()
 
-All it takes to draw a simple text visualization is 9 lines of code:
+.. image:: ../examples/exports/2-simple-text.png
+   :class: center
+   :width: 62%
+
+All it takes to draw a simple text visualization is 10 lines of code:
 
 	1. Three lines to import matplotlib, Multiplex and the visualization style;
-	2. Set up the visualization object;
-	3. Draw and show the visualization, including a title and caption.
+	2. Three lines to set up the visualization object, load the data and set the style;
+	3. Four lines to draw and show the visualization, including a title and caption.
 
 Multiplex abstracts the tedious process of manually programming which elements go where, and lets you create beautiful visualizations with ease.
 

docs/.doctrees/index.doctree

@@ -199,6 +199,7 @@ <h2>Why Multiplex?<a class="headerlink" href="#why-multiplex" title="Permalink t
 <blockquote>
 <div><p>If Multiplex is based on matplotlib, why not use matplotlib directly?</p>
 </div></blockquote>
+<img alt="_images/0-multiplex-dark-style.png" class="example" src="_images/0-multiplex-dark-style.png" />
 <p>Multiplex does not replace matplotlib.
 Anything that you can do with Multiplex, you can also do with matplotlib.
 What Multiplex does is make it easier to create beautiful visualizations.
@@ -209,31 +210,34 @@ <h2>Why Multiplex?<a class="headerlink" href="#why-multiplex" title="Permalink t
 <li><p>New types of visualizations not available in matplotlib, such as the graph and text-based visualizations.</p></li>
 </ul>
 <p>For example, you can create a text visualization with a simple function call, including all styling options:</p>
-<div class="highlight-python notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
-2
-3
-4
-5
-6
-7
-8
-9</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="kn">as</span> <span class="nn">plt</span>
+<div class="highlight-python notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="kn">as</span> <span class="nn">plt</span>
 <span class="kn">from</span> <span class="nn">multiplex</span> <span class="kn">import</span> <span class="n">drawable</span>
 <span class="n">plt</span><span class="o">.</span><span class="n">style</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;styles&#39;</span><span class="p">,</span> <span class="s2">&quot;multiplex.style&quot;</span><span class="p">))</span>
-<span class="n">viz</span> <span class="o">=</span> <span class="n">drawable</span><span class="o">.</span><span class="n">Drawable</span><span class="p">(</span><span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="p">)))</span>
-<span class="n">text</span> <span class="o">=</span> <span class="s1">&#39;Lorem ipsum dolor sit amet, consectetur adipiscing elit.&#39;</span>
-<span class="n">viz</span><span class="o">.</span><span class="n">draw_text_annotation</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s1">&#39;justify&#39;</span><span class="p">,</span> <span class="n">fontfamily</span><span class="o">=</span><span class="s1">&#39;serif&#39;</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="s1">&#39;large&#39;</span><span class="p">,</span> <span class="n">lpad</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">rpad</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
-<span class="n">viz</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">&#39;Text visualization&#39;</span><span class="p">,</span> <span class="n">loc</span><span class="o">=</span><span class="s1">&#39;left&#39;</span><span class="p">)</span>
-<span class="n">viz</span><span class="o">.</span><span class="n">set_caption</span><span class="p">(</span><span class="s2">&quot;It doesn&#39;t take much to create text visualizations with Multiplex!&quot;</span><span class="p">)</span>
+<span class="n">viz</span> <span class="o">=</span> <span class="n">drawable</span><span class="o">.</span><span class="n">Drawable</span><span class="p">(</span><span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">2</span><span class="p">)))</span>
+<span class="n">paragraph</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;Anthony Lopes is a Portuguese professional footballer who plays for Olympique Lyonnais as a goalkeeper. He came through the youth ranks at Lyon, being called to the first team in 2011 and making his debut the following year.&quot;&quot;&quot;</span>
+<span class="n">style</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">&#39;align&#39;</span><span class="p">:</span> <span class="s1">&#39;justify&#39;</span><span class="p">,</span> <span class="s1">&#39;fontfamily&#39;</span><span class="p">:</span> <span class="s1">&#39;serif&#39;</span><span class="p">,</span> <span class="s1">&#39;alpha&#39;</span><span class="p">:</span> <span class="mf">0.9</span><span class="p">,</span> <span class="s1">&#39;lineheight&#39;</span><span class="p">:</span> <span class="mf">1.25</span><span class="p">,</span> <span class="s1">&#39;lpad&#39;</span><span class="p">:</span> <span class="mf">0.1</span><span class="p">,</span> <span class="s1">&#39;rpad&#39;</span><span class="p">:</span> <span class="mf">0.1</span> <span class="p">}</span>
+<span class="n">viz</span><span class="o">.</span><span class="n">draw_text_annotation</span><span class="p">(</span><span class="n">paragraph</span><span class="p">,</span> <span class="o">**</span><span class="n">style</span><span class="p">)</span>
+<span class="n">viz</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">&#39;Profile: Anthony Lopes&#39;</span><span class="p">,</span> <span class="n">loc</span><span class="o">=</span><span class="s1">&#39;left&#39;</span><span class="p">)</span>
+<span class="n">viz</span><span class="o">.</span><span class="n">set_caption</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;Wikipedia is a useful repository to get more information about anything. Below is an excerpt from the Wikipedia profile of footballer Anthony Lopes.&quot;&quot;&quot;</span><span class="p">)</span>
 <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 </pre></div>
 </td></tr></table></div>
-<p>All it takes to draw a simple text visualization is 9 lines of code:</p>
+<a class="center reference internal image-reference" href="_images/2-simple-text.png"><img alt="_images/2-simple-text.png" class="center" src="_images/2-simple-text.png" style="width: 62%;" /></a>
+<p>All it takes to draw a simple text visualization is 10 lines of code:</p>
 <blockquote>
 <div><ol class="arabic simple">
 <li><p>Three lines to import matplotlib, Multiplex and the visualization style;</p></li>
-<li><p>Set up the visualization object;</p></li>
-<li><p>Draw and show the visualization, including a title and caption.</p></li>
+<li><p>Three lines to set up the visualization object, load the data and set the style;</p></li>
+<li><p>Four lines to draw and show the visualization, including a title and caption.</p></li>
 </ol>
 </div></blockquote>
 <p>Multiplex abstracts the tedious process of manually programming which elements go where, and lets you create beautiful visualizations with ease.</p>