Fixes #13 : Documented installation and re-rendered the docs.

jazzband · Jan 3, 2012 · 7a9ee67 · 7a9ee67
1 parent 690111e
commit 7a9ee67
Show file tree

Hide file tree

Showing 20 changed files with 250 additions and 70 deletions.
diff --git a/doc_src/conf.py b/doc_src/conf.py
@@ -41,14 +41,14 @@
 
 # General information about the project.
 project = u'Django Categories'
-copyright = u'2010, CoreyOordt'
+copyright = u'2010-2012, Corey Oordt'
 
 # 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 = categories.get_version()
+version = categories.get_version(short=True)
 # The full version, including alpha/beta/rc tags.
 release = categories.get_version()
 

diff --git a/doc_src/index.rst b/doc_src/index.rst
@@ -8,6 +8,7 @@ Contents:
    :maxdepth: 2
    :glob:
 
+   installation
    getting_started
    usage
    registering_models

diff --git a/doc_src/installation.rst b/doc_src/installation.rst
@@ -0,0 +1,19 @@
+============
+Installation
+============
+
+1. Install django-categories::
+
+    pip install django-categories
+
+2. Add ``"categories"`` and ``"editor"`` to your ``INSTALLED_APPS`` list in your project's ``settings.py`` file.
+
+   .. code-block:: python
+
+       INSTALLED_APPS = [
+           # ...
+           "categories",
+           "editor",
+       ]
+
+3. Run ``./manage.py syncdb`` (or ``./manage.py migrate categories`` if you are using `South <http://south.aeracode.org/>`_)
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
@@ -8,6 +8,7 @@ Contents:
    :maxdepth: 2
    :glob:
 
+   installation
    getting_started
    usage
    registering_models

diff --git a/docs/_sources/installation.txt b/docs/_sources/installation.txt
@@ -0,0 +1,19 @@
+============
+Installation
+============
+
+1. Install django-categories::
+
+    pip install django-categories
+
+2. Add ``"categories"`` and ``"editor"`` to your ``INSTALLED_APPS`` list in your project's ``settings.py`` file.
+
+   .. code-block:: python
+
+       INSTALLED_APPS = [
+           # ...
+           "categories",
+           "editor",
+       ]
+
+3. Run ``./manage.py syncdb`` (or ``./manage.py migrate categories`` if you are using `South <http://south.aeracode.org/>`_)
diff --git a/docs/adding_the_fields.html b/docs/adding_the_fields.html
@@ -6,13 +6,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Adding the fields to the database &mdash; Django Categories v0.8.2 documentation</title>
+    <title>Adding the fields to the database &mdash; Django Categories v0.8.6 documentation</title>
     <link rel="stylesheet" href="_static/default.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.8.2',
+        VERSION:     '0.8.6',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -21,13 +21,13 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Django Categories v0.8.2 documentation" href="index.html" />
+    <link rel="top" title="Django Categories v0.8.6 documentation" href="index.html" />
     <link rel="next" title="Reference" href="reference/index.html" />
     <link rel="prev" title="Registering Models" href="registering_models.html" /> 
   </head>
   <body>
 <div id="docstitle">
-	<p>Django Categories v0.8.2 documentation</p>
+	<p>Django Categories v0.8.6 documentation</p>
 </div>
 <div id="header">
 	<div id="title"><h1>Adding the fields to the database</h1></div>
@@ -45,6 +45,7 @@
   <div class="sphinxsidebarwrapper">
 	<ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul>
 	<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Using categories in templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="registering_models.html">Registering Models</a></li>
@@ -110,7 +111,7 @@ <h2>Reconfiguring Fields<a class="headerlink" href="#reconfiguring-fields" title
       </div>
     <div class="footer">
     <p>
-      &copy; Copyright 2010, CoreyOordt.
+      &copy; Copyright 2010-2012, Corey Oordt.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
 	</p>
     </div>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -6,13 +6,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Index &mdash; Django Categories v0.8.2 documentation</title>
+    <title>Index &mdash; Django Categories v0.8.6 documentation</title>
     <link rel="stylesheet" href="_static/default.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.8.2',
+        VERSION:     '0.8.6',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -21,11 +21,11 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Django Categories v0.8.2 documentation" href="index.html" /> 
+    <link rel="top" title="Django Categories v0.8.6 documentation" href="index.html" /> 
   </head>
   <body>
 <div id="docstitle">
-	<p>Django Categories v0.8.2 documentation</p>
+	<p>Django Categories v0.8.6 documentation</p>
 </div>
 <div id="header">
 	<div id="title"><h1>Index</h1></div>
@@ -41,6 +41,7 @@
   <div class="sphinxsidebarwrapper">
 	<ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul>
 	<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Using categories in templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="registering_models.html">Registering Models</a></li>
@@ -101,7 +102,7 @@ <h2 id="R">R</h2>
       </div>
     <div class="footer">
     <p>
-      &copy; Copyright 2010, CoreyOordt.
+      &copy; Copyright 2010-2012, Corey Oordt.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
 	</p>
     </div>

diff --git a/docs/getting_started.html b/docs/getting_started.html
@@ -6,13 +6,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Getting Started &mdash; Django Categories v0.8.2 documentation</title>
+    <title>Getting Started &mdash; Django Categories v0.8.6 documentation</title>
     <link rel="stylesheet" href="_static/default.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.8.2',
+        VERSION:     '0.8.6',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -21,13 +21,13 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Django Categories v0.8.2 documentation" href="index.html" />
+    <link rel="top" title="Django Categories v0.8.6 documentation" href="index.html" />
     <link rel="next" title="Using categories in templates" href="usage.html" />
-    <link rel="prev" title="Django Categories v 0.8.2" href="index.html" /> 
+    <link rel="prev" title="Installation" href="installation.html" /> 
   </head>
   <body>
 <div id="docstitle">
-	<p>Django Categories v0.8.2 documentation</p>
+	<p>Django Categories v0.8.6 documentation</p>
 </div>
 <div id="header">
 	<div id="title"><h1>Getting Started</h1></div>
@@ -36,7 +36,7 @@
 		<li id="page_buttons">
 			<div class="headerButton"><a href="genindex.html" title="General Index" accesskey="I">index</a></div>
 			<div class="headerButton"><a href="usage.html" title="Using categories in templates" accesskey="N">next</a></div>
-			<div class="headerButton"><a href="index.html" title="Django Categories v 0.8.2" accesskey="P">previous</a></div>
+			<div class="headerButton"><a href="installation.html" title="Installation" accesskey="P">previous</a></div>
 		</li>
 	</ul>
 </div>
@@ -45,6 +45,7 @@
   <div class="sphinxsidebarwrapper">
 	<ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul>
 	<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="">Getting Started</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#connecting-your-model-with-django-categories">Connecting your model with Django-Categories</a></li>
 </ul>
@@ -150,7 +151,7 @@ <h2>Connecting your model with Django-Categories<a class="headerlink" href="#con
       </div>
     <div class="footer">
     <p>
-      &copy; Copyright 2010, CoreyOordt.
+      &copy; Copyright 2010-2012, Corey Oordt.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
 	</p>
     </div>

diff --git a/docs/index.html b/docs/index.html
@@ -6,13 +6,13 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Django Categories v 0.8.2 &mdash; Django Categories v0.8.2 documentation</title>
+    <title>Django Categories v 0.8 &mdash; Django Categories v0.8.6 documentation</title>
     <link rel="stylesheet" href="_static/default.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.8.2',
+        VERSION:     '0.8.6',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -21,20 +21,20 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Django Categories v0.8.2 documentation" href="#" />
-    <link rel="next" title="Getting Started" href="getting_started.html" /> 
+    <link rel="top" title="Django Categories v0.8.6 documentation" href="#" />
+    <link rel="next" title="Installation" href="installation.html" /> 
   </head>
   <body>
 <div id="docstitle">
-	<p>Django Categories v0.8.2 documentation</p>
+	<p>Django Categories v0.8.6 documentation</p>
 </div>
 <div id="header">
-	<div id="title"><h1>Django Categories v 0.8.2</h1></div>
+	<div id="title"><h1>Django Categories v 0.8</h1></div>
 	<ul id="headerButtons">
 		<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
 		<li id="page_buttons">
 			<div class="headerButton"><a href="genindex.html" title="General Index" accesskey="I">index</a></div>
-			<div class="headerButton"><a href="getting_started.html" title="Getting Started" accesskey="N">next</a></div>
+			<div class="headerButton"><a href="installation.html" title="Installation" accesskey="N">next</a></div>
 		</li>
 	</ul>
 </div>
@@ -43,6 +43,7 @@
   <div class="sphinxsidebarwrapper">
 	<ul><li class="toctree-l1"><a href="#">Main Page</a></li></ul>
 	<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Using categories in templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="registering_models.html">Registering Models</a></li>
@@ -83,10 +84,11 @@ <h3>This Page</h3>
           <div class="body">
 
   <div class="section" id="django-categories-v-version">
-<h1>Django Categories v 0.8.2<a class="headerlink" href="#django-categories-v-version" title="Permalink to this headline">¶</a></h1>
+<h1>Django Categories v 0.8<a class="headerlink" href="#django-categories-v-version" title="Permalink to this headline">¶</a></h1>
 <p>Contents:</p>
 <div class="toctree-wrapper compound">
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="getting_started.html#connecting-your-model-with-django-categories">Connecting your model with Django-Categories</a></li>
 </ul>
@@ -132,14 +134,14 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
       </div>
     <div class="footer">
     <p>
-      &copy; Copyright 2010, CoreyOordt.
+      &copy; Copyright 2010-2012, Corey Oordt.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
 	</p>
     </div>
       <div class="clearer"></div>
     </div>
 	<div id="breadcrumbs">
-		Django Categories v 0.8.2
+		Django Categories v 0.8
 		</ul>
 	</div>
 	<script type="text/javascript" charset="utf-8" src="_static/toc.js"></script>