Merge pull request vikingco#69 from gvangool/docs

Docs fixes
gvangool · Oct 2, 2015 · 2378b4a · 2378b4a
2 parents dbd1c33 + 1ccfa7c
commit 2378b4a
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 26 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,19 @@
+Ben Mason <ben@sharkbyte.co.uk>
+Dirk Moors <dirkmoors@gmail.com>
+Gert Van Gool <gertvangool@gmail.com>
+Giovanni Collazo <hello@gcollazo.com>
+Jakub Paczkowski <jakub@paczkowski.eu>
+Jan Fabry <jan.fabry@monkeyman.be>
+Jef Geskens <jef.geskens@gmail.com>
+Jonathan Slenders <jonathan@slenders.be>
+José Padilla <jpadilla@webapplicate.com>
+Linsy Aerts <linsy.aerts@mobilevikings.com>
+Maarten Timmerman <maarten.timmerman@mobilevikings.com>
+Niels Van Och <niels.vanoch@gmail.com>
+Olivier Sels <olivier.sels@gmail.com>
+OpenShift guest <sam@jumpstartz.com>
+San Gillis <gillis.san@gmail.com>
+Simon Andersson <simon.andersson@keybroker.com>
+Steven Klass <sklass@7stalks.com>
+sgillis <gillis.san@gmail.com>
+techdragon <lucractius@me.com>
diff --git a/Makefile b/Makefile
@@ -7,7 +7,7 @@ docs: $(DOCS_MAKE_CMD)
 $(DOCS_MAKE_CMD):
 	DJANGO_SETTINGS_MODULE=test_proj.settings $(MAKE) -C docs $@
 
-clean: docs_clean
+clean:
 	$(MAKE) -C docs clean
 
 test:

diff --git a/README.rst b/README.rst
@@ -3,13 +3,6 @@ Django States
 
 |Build Status|
 
-Authors:
-
--  Jonathan Slenders, City Live nv
--  Gert van Gool, City Live nv
--  Maarten Timmerman, City Live nv
--  Steven (rh0dium), Pivotal Engergy Solutions, Phoenix Arizona
-
 Description
 -----------
 
@@ -20,7 +13,7 @@ objects.
 Installation
 ------------
 
-::
+.. code:: sh
 
     pip install django-states
 
@@ -79,7 +72,9 @@ Note: If you're creating a ``DataMigration`` in
 `South <http://south.aeracode.org/>`__, remember to use
 ``obj.save(no_state_validation=True)``
 
-Usage example::
+Usage example:
+
+.. code:: python
 
    p = Purchase()
 
@@ -132,7 +127,9 @@ Groups
 Sometimes you want to group several states together, since for a certain
 view (or other content) it doesn't really matter which of the states it
 is. We support 2 different state groups, inclusive (only these) or
-exclusive (everything but these)::
+exclusive (everything but these):
+
+.. code:: python
 
   class is_paid(StateGroup):
       states = ['paid', 'shipped']

diff --git a/docs/conf.py b/docs/conf.py
@@ -92,7 +92,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/django_states/conf.rst b/docs/django_states/conf.rst
@@ -1,5 +1,5 @@
 ``django_states.conf``
-================
+======================
 
 .. automodule:: django_states.conf
    :members:

diff --git a/docs/django_states/fields.rst b/docs/django_states/fields.rst
@@ -1,5 +1,5 @@
 ``django_states.fields``
-==================
+========================
 
 .. automodule:: django_states.fields
    :members:

diff --git a/docs/django_states/log.rst b/docs/django_states/log.rst
@@ -1,5 +1,5 @@
 ``django_states.log``
-===============
+=====================
 
 .. automodule:: django_states.log
    :members:

diff --git a/docs/django_states/machine.rst b/docs/django_states/machine.rst
@@ -1,5 +1,5 @@
 ``django_states.machine``
-===================
+=========================
 
 .. automodule:: django_states.machine
    :members:

diff --git a/docs/django_states/models.rst b/docs/django_states/models.rst
@@ -1,5 +1,5 @@
 ``django_states.models``
-==================
+========================
 
 .. automodule:: django_states.models
    :members:

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,15 +12,15 @@ Internal API
 .. toctree::
    :maxdepth: 2
 
-   states2/conf
-   states2/exceptions
-   states2/fields
-   states2/log
-   states2/machine
-   states2/model_methods
-   states2/models
-   states2/templatetags
-   states2/views
+   django_states/conf
+   django_states/exceptions
+   django_states/fields
+   django_states/log
+   django_states/machine
+   django_states/model_methods
+   django_states/models
+   django_states/templatetags
+   django_states/views
 
 
 Indices and tables