From 7a9ee6785b71aa4672ccb9ee825f0234a44bb2e1 Mon Sep 17 00:00:00 2001 From: Corey Oordt Date: Tue, 3 Jan 2012 09:16:34 -0500 Subject: [PATCH] Fixes #13 : Documented installation and re-rendered the docs. --- doc_src/conf.py | 4 +- doc_src/index.rst | 1 + doc_src/installation.rst | 19 ++++ docs/_sources/index.txt | 1 + docs/_sources/installation.txt | 19 ++++ docs/adding_the_fields.html | 11 +- docs/genindex.html | 11 +- docs/getting_started.html | 15 +-- docs/index.html | 22 ++-- docs/installation.html | 127 ++++++++++++++++++++++++ docs/objects.inv | Bin 505 -> 508 bytes docs/reference/index.html | 11 +- docs/reference/management_commands.html | 11 +- docs/reference/models.html | 11 +- docs/reference/settings.html | 11 +- docs/reference/templatetags.html | 11 +- docs/registering_models.html | 11 +- docs/search.html | 11 +- docs/searchindex.js | 2 +- docs/usage.html | 11 +- 20 files changed, 250 insertions(+), 70 deletions(-) create mode 100644 doc_src/installation.rst create mode 100644 docs/_sources/installation.txt create mode 100644 docs/installation.html diff --git a/doc_src/conf.py b/doc_src/conf.py index 39a11b9..51ac114 100644 --- a/doc_src/conf.py +++ b/doc_src/conf.py @@ -41,14 +41,14 @@ master_doc = 'index' # 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 index d78f824..d86c186 100644 --- 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 new file mode 100644 index 0000000..5e66eaa --- /dev/null +++ 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 `_) diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index d78f824..d86c186 100644 --- 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 new file mode 100644 index 0000000..5e66eaa --- /dev/null +++ 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 `_) diff --git a/docs/adding_the_fields.html b/docs/adding_the_fields.html index b1777c6..21d2666 100644 --- a/docs/adding_the_fields.html +++ b/docs/adding_the_fields.html @@ -6,13 +6,13 @@ - Adding the fields to the database — Django Categories v0.8.2 documentation + Adding the fields to the database — Django Categories v0.8.6 documentation - +
-

Django Categories v0.8.2 documentation

+

Django Categories v0.8.6 documentation