Update docs to 1.0.0

juanfcocontreras · Nov 25, 2015 · d61f859 · d61f859
1 parent 97ae1ed
commit d61f859
Show file tree

Hide file tree

Showing 64 changed files with 277 additions and 245 deletions.
diff --git a/latest/.buildinfo b/latest/.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: 4becbf3f1ae5ba30da09219c0e9da88d
+config: 1fdce9e3cd6a9b7e5dc51e563522e832
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/_images/basic.pdf.png b/latest/_images/basic.pdf.png
diff --git a/latest/_images/basic_maketitle.pdf.png b/latest/_images/basic_maketitle.pdf.png
diff --git a/latest/_images/basic_maketitle2.pdf.png b/latest/_images/basic_maketitle2.pdf.png
diff --git a/latest/_images/full.pdf.png b/latest/_images/full.pdf.png
diff --git a/latest/_images/lists.pdf.png b/latest/_images/lists.pdf.png
diff --git a/latest/_images/matplotlib_ex-dpi.pdf.png b/latest/_images/matplotlib_ex-dpi.pdf.png
diff --git a/latest/_images/matplotlib_ex-facecolor.pdf.png b/latest/_images/matplotlib_ex-facecolor.pdf.png
diff --git a/latest/_images/multirow.pdf.png b/latest/_images/multirow.pdf.png
diff --git a/latest/_images/numpy_ex.pdf.png b/latest/_images/numpy_ex.pdf.png
diff --git a/latest/_images/own_commands_ex.pdf.png b/latest/_images/own_commands_ex.pdf.png
diff --git a/latest/_images/quantities_ex.pdf.png b/latest/_images/quantities_ex.pdf.png
diff --git a/latest/_images/subfigures.pdf.png b/latest/_images/subfigures.pdf.png
diff --git a/latest/_sources/changelog.txt b/latest/_sources/changelog.txt
@@ -1,15 +1,17 @@
 Change Log
 ==========
 
-All notable changes to this project will be documented on this page.
-This project adheres to `Semantic Versioning <http://semver.org/>`_.
-
-
-Unreleased_
------------
-This realease will bring some great changes. The whole package has been
-refactored and actual documentation has been added. Because of this, things
-have been moved an renamed.
+All notable changes to this project will be documented on this page.  This
+project adheres to `Semantic Versioning <http://semver.org/>`_.  See the
+`latest docs <../latest/>`_ for changes that have not yet been released and are
+only present in the development version.
+
+1.0.0_ - `docs <../v1.0.0/>`__ - 2015-11-25
+-------------------------------------------
+This realease brings some great changes. The whole package has been refactored
+and actual documentation has been added. Because of this, things have been
+moved an renamed. One of the most notable changes is that all normal text is
+now escaped by default.
 
 Changed
 ~~~~~~~
@@ -153,7 +155,7 @@ Added
 - A ``__repr__`` method, so printing LaTeX objects gives more useful
   information now.
 
-0.8.0_ - 23-05-2015
+0.8.0_ - 2015-05-23
 -------------------
 Added
 ~~~~~
@@ -186,7 +188,7 @@ Fixed
   enabled
 
 
-0.7.1_ - 21-03-2015
+0.7.1_ - 2015-03-21
 -------------------
 Added
 ~~~~~
@@ -204,7 +206,7 @@ Fixed
   with some filenames (dots in directories and a file without an extension)
 
 
-0.7.0_ - 17-03-2015
+0.7.0_ - 2015-03-17
 -------------------
 Added
 ~~~~~
@@ -222,7 +224,7 @@ Fixed
 - Fix a lot of bugs in the `.escape_latex` function
 
 
-0.6.1_ - 11-01-2015
+0.6.1_ - 2015-01-11
 -------------------
 Added
 ~~~~~
@@ -233,7 +235,7 @@ Fixed
 - Bug in VectorName
 
 
-0.6_ - 07-01-2015
+0.6_ - 2015-01-07
 -----------------
 Added
 ~~~~~
@@ -242,21 +244,21 @@ Added
 - ``with`` statement support
 
 
-0.5_ - 02-06-2014
+0.5_ - 2014-06-02
 -----------------
 Added
 ~~~~~
 - Python 2.7 support
 
 
-0.4.2_ - 18-03-2014
+0.4.2_ - 2014-03-18
 -------------------
 Added
 ~~~~~
 - More table types
 
 
-0.4.1_ - 29-01-2014
+0.4.1_ - 2014-01-29
 -------------------
 Added
 ~~~~~
@@ -267,7 +269,8 @@ Fixed
 - Fix package delegation with duplicate packages
 
 
-.. _Unreleased: https://github.com/JelteF/PyLaTeX/compare/v0.8.0...HEAD
+.. _Unreleased: https://github.com/JelteF/PyLaTeX/compare/v1.0.0...HEAD
+.. _1.0.0: https://github.com/JelteF/PyLaTeX/compare/v0.8.0...v1.0.0
 .. _0.8.0: https://github.com/JelteF/PyLaTeX/compare/v0.7.1...v0.8.0
 .. _0.7.1: https://github.com/JelteF/PyLaTeX/compare/v0.7.0...v0.7.1
 .. _0.7.0: https://github.com/JelteF/PyLaTeX/compare/v0.6.1...v0.7.0

diff --git a/latest/_sources/contributing.txt b/latest/_sources/contributing.txt
@@ -27,9 +27,10 @@ For Ubuntu and other Debian based systems::
 
 Getting the source code
 ~~~~~~~~~~~~~~~~~~~~~~~
-You need your own fork of the Github repository by using the Github fork
-button. You will then need to clone your version of the repo using the normal
-way, something like this::
+You need your own fork of the `Github repository
+<https://github.com/JelteF/PyLaTeX>`_ by using the Github fork button. You will
+then need to clone your version of the repo using the normal way, something
+like this::
 
     git clone [email protected]:YourUserName/pylatex
     cd pylatex

diff --git a/latest/_sources/index.txt b/latest/_sources/index.txt
@@ -71,6 +71,13 @@ operating systems to test it on. Pull requests that fix those issues are always
 welcome though. Issues have been fixed for Windows and it seems that compiling
 to pdf is currently working.
 
+Contributing
+------------
+Read the :doc:`contributing` page for tips and rules when you want to
+contribute. To just see the source code, you should go to the `Github
+repository <https://github.com/JelteF/PyLaTeX/>`_.
+
+
 
 
 .. toctree::

diff --git a/latest/_sources/usage.txt b/latest/_sources/usage.txt
@@ -89,3 +89,9 @@ LaTeX strings should just be used directly in the document. This is why the
 not be escaped. One important thing to note about this class is that appending
 a `~.NoEscape` type string to a regular string results in a regular string,
 since one type has to be chosen and the most conservative approach is taken.
+
+There is also another way to make sure strings are not escaped. This is by
+setting the `~.LatexObject.escape` attribute to `False` on the class that is
+the container of the string. Keep in mind though that any strings that are
+added to that object will not be escaped when doing this. So, only use this
+method for objects that don't contain possibly unsafe strings.
diff --git a/latest/_static/examples/basic.pdf.png b/latest/_static/examples/basic.pdf.png
diff --git a/latest/_static/examples/basic_maketitle.pdf.png b/latest/_static/examples/basic_maketitle.pdf.png
diff --git a/latest/_static/examples/basic_maketitle2.pdf.png b/latest/_static/examples/basic_maketitle2.pdf.png
diff --git a/latest/_static/examples/full.pdf.png b/latest/_static/examples/full.pdf.png
diff --git a/latest/_static/examples/lists.pdf.png b/latest/_static/examples/lists.pdf.png
diff --git a/latest/_static/examples/matplotlib_ex-dpi.pdf.png b/latest/_static/examples/matplotlib_ex-dpi.pdf.png
diff --git a/latest/_static/examples/matplotlib_ex-facecolor.pdf.png b/latest/_static/examples/matplotlib_ex-facecolor.pdf.png
diff --git a/latest/_static/examples/multirow.pdf.png b/latest/_static/examples/multirow.pdf.png
diff --git a/latest/_static/examples/numpy_ex.pdf.png b/latest/_static/examples/numpy_ex.pdf.png
diff --git a/latest/_static/examples/own_commands_ex.pdf.png b/latest/_static/examples/own_commands_ex.pdf.png
diff --git a/latest/_static/examples/quantities_ex.pdf.png b/latest/_static/examples/quantities_ex.pdf.png
diff --git a/latest/_static/examples/subfigures.pdf.png b/latest/_static/examples/subfigures.pdf.png
diff --git a/latest/api.html b/latest/api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>API reference &mdash; PyLaTeX 0.8.0 documentation</title>
+  <title>API reference &mdash; PyLaTeX 1.0.0-dev documentation</title>
 
 
 
@@ -52,7 +52,7 @@
 
 
 
-    <link rel="top" title="PyLaTeX 0.8.0 documentation" href="index.html"/>
+    <link rel="top" title="PyLaTeX 1.0.0-dev documentation" href="index.html"/>
         <link rel="next" title="pylatex.base_classes.command" href="pylatex/pylatex.base_classes.command.html"/>
         <link rel="prev" title="Subfigure example" href="examples/subfigure.html"/> 
 
@@ -82,7 +82,7 @@
 
 
               <div class="version">
-                0.8.0
+                1.0.0
               </div>
 
 
@@ -239,7 +239,7 @@ <h1>API reference<a class="headerlink" href="#api-reference" title="Permalink to
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.8.0',
+            VERSION:'1.0.0-dev',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/latest/changelog.html b/latest/changelog.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Change Log &mdash; PyLaTeX 0.8.0 documentation</title>
+  <title>Change Log &mdash; PyLaTeX 1.0.0-dev documentation</title>
 
 
 
@@ -52,7 +52,7 @@
 
 
 
-    <link rel="top" title="PyLaTeX 0.8.0 documentation" href="index.html"/>
+    <link rel="top" title="PyLaTeX 1.0.0-dev documentation" href="index.html"/>
         <link rel="next" title="How to contribute" href="contributing.html"/>
         <link rel="prev" title="pylatex.utils" href="pylatex/pylatex.utils.html"/> 
 
@@ -82,7 +82,7 @@
 
 
               <div class="version">
-                0.8.0
+                1.0.0
               </div>
 
 
@@ -108,48 +108,48 @@
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API reference</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="">Change Log</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#docs-2015-11-25">1.0.0 - docs - 2015-11-25</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#removed">Removed</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id1">0.8.0 - 23-05-2015</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id1">0.8.0 - 2015-05-23</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id2">Added</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id3">Changed</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id4">0.7.1 - 21-03-2015</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id4">0.7.1 - 2015-03-21</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id5">Added</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id6">Changed</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id7">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id8">0.7.0 - 17-03-2015</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id8">0.7.0 - 2015-03-17</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id9">Added</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id10">Changed</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id11">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id12">0.6.1 - 11-01-2015</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id12">0.6.1 - 2015-01-11</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id13">Added</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id14">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id15">0.6 - 07-01-2015</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id15">0.6 - 2015-01-07</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id16">Added</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id17">0.5 - 02-06-2014</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id17">0.5 - 2014-06-02</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id18">Added</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id19">0.4.2 - 18-03-2014</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id19">0.4.2 - 2014-03-18</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id20">Added</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#id21">0.4.1 - 29-01-2014</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id21">0.4.1 - 2014-01-29</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#id22">Added</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#id23">Fixed</a></li>
 </ul>
@@ -203,13 +203,16 @@
 
   <div class="section" id="change-log">
 <h1>Change Log<a class="headerlink" href="#change-log" title="Permalink to this headline">¶</a></h1>
-<p>All notable changes to this project will be documented on this page.
-This project adheres to <a class="reference external" href="http://semver.org/">Semantic Versioning</a>.</p>
-<div class="section" id="unreleased">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.8.0...HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
-<p>This realease will bring some great changes. The whole package has been
-refactored and actual documentation has been added. Because of this, things
-have been moved an renamed.</p>
+<p>All notable changes to this project will be documented on this page.  This
+project adheres to <a class="reference external" href="http://semver.org/">Semantic Versioning</a>.  See the
+<a class="reference external" href="../latest/">latest docs</a> for changes that have not yet been released and are
+only present in the development version.</p>
+<div class="section" id="docs-2015-11-25">
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.8.0...v1.0.0">1.0.0</a> - <a class="reference external" href="../v1.0.0/">docs</a> - 2015-11-25<a class="headerlink" href="#docs-2015-11-25" title="Permalink to this headline">¶</a></h2>
+<p>This realease brings some great changes. The whole package has been refactored
+and actual documentation has been added. Because of this, things have been
+moved an renamed. One of the most notable changes is that all normal text is
+now escaped by default.</p>
 <div class="section" id="changed">
 <h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -321,7 +324,7 @@ <h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id1">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.7.1...v0.8.0">0.8.0</a> - 23-05-2015<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.7.1...v0.8.0">0.8.0</a> - 2015-05-23<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id2">
 <h3>Added<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -360,7 +363,7 @@ <h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id4">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.7.0...v0.7.1">0.7.1</a> - 21-03-2015<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.7.0...v0.7.1">0.7.1</a> - 2015-03-21<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id5">
 <h3>Added<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -384,7 +387,7 @@ <h3>Fixed<a class="headerlink" href="#id7" title="Permalink to this headline">¶
 </div>
 </div>
 <div class="section" id="id8">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.6.1...v0.7.0">0.7.0</a> - 17-03-2015<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.6.1...v0.7.0">0.7.0</a> - 2015-03-17<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id9">
 <h3>Added<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -408,7 +411,7 @@ <h3>Fixed<a class="headerlink" href="#id11" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id12">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.6...v0.6.1">0.6.1</a> - 11-01-2015<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.6...v0.6.1">0.6.1</a> - 2015-01-11<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id13">
 <h3>Added<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -423,7 +426,7 @@ <h3>Fixed<a class="headerlink" href="#id14" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id15">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.5...v0.6">0.6</a> - 07-01-2015<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.5...v0.6">0.6</a> - 2015-01-07<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id16">
 <h3>Added<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -434,7 +437,7 @@ <h3>Added<a class="headerlink" href="#id16" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id17">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.4.2...v0.5">0.5</a> - 02-06-2014<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.4.2...v0.5">0.5</a> - 2014-06-02<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id18">
 <h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -443,7 +446,7 @@ <h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id19">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.4.1...v0.4.2">0.4.2</a> - 18-03-2014<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/v0.4.1...v0.4.2">0.4.2</a> - 2014-03-18<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id20">
 <h3>Added<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -452,7 +455,7 @@ <h3>Added<a class="headerlink" href="#id20" title="Permalink to this headline">
 </div>
 </div>
 <div class="section" id="id21">
-<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/68ddef6bc43a5dff42105c3a38068d87d99d049f...v0.4.1">0.4.1</a> - 29-01-2014<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/JelteF/PyLaTeX/compare/68ddef6bc43a5dff42105c3a38068d87d99d049f...v0.4.1">0.4.1</a> - 2014-01-29<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id22">
 <h3>Added<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
@@ -509,7 +512,7 @@ <h3>Fixed<a class="headerlink" href="#id23" title="Permalink to this headline">
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.8.0',
+            VERSION:'1.0.0-dev',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true