From ff9152f01179a51388f4c9a4a3ad8591f39e5f05 Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:35:45 +0200 Subject: [PATCH 1/6] Fixes Makefile (make clean) No rule for docs_clean existed --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 8466b61..985ca7f 100644 --- a/Makefile +++ b/Makefile @@ -7,5 +7,5 @@ docs: $(DOCS_MAKE_CMD) $(DOCS_MAKE_CMD): DJANGO_SETTINGS_MODULE=test_proj.settings $(MAKE) -C docs $@ -clean: docs_clean +clean: $(MAKE) -C docs clean From 72b949dffc4dc477cc5349e83928f292425957ae Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:36:17 +0200 Subject: [PATCH 2/6] Updates to new default Sphinx theme --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 97dcc6f..eebdb72 100644 --- 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 From c1ad07702d48874cf7ec823aec11054314a96e66 Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:36:33 +0200 Subject: [PATCH 3/6] Fixes Restructured Text syntaxt --- docs/django_states/conf.rst | 2 +- docs/django_states/fields.rst | 2 +- docs/django_states/log.rst | 2 +- docs/django_states/machine.rst | 2 +- docs/django_states/models.rst | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/django_states/conf.rst b/docs/django_states/conf.rst index 2162290..fc110e4 100644 --- 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 index 2c2fcb1..dc0f035 100644 --- 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 index 4fbaa1f..d827a7a 100644 --- 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 index 91614dd..d59a533 100644 --- 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 index f2bfe56..bdbb9f2 100644 --- a/docs/django_states/models.rst +++ b/docs/django_states/models.rst @@ -1,5 +1,5 @@ ``django_states.models`` -================== +======================== .. automodule:: django_states.models :members: From d5c2eeba11fb8e9c0994f2d6fe0ea3babac39a4c Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:36:48 +0200 Subject: [PATCH 4/6] Corrects TOC tree --- docs/index.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 797011b..5a9c8b4 100644 --- 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 From c923ee43c44a0457d09fbc745c3b41ea282f3a8f Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:45:24 +0200 Subject: [PATCH 5/6] Adds AUTHORS file with contributors Generated based the git log file (and cleaned by hand to remove duplicates):: git log --all --format="%aN <%aE>" | sort -u --- AUTHORS | 19 +++++++++++++++++++ README.rst | 7 ------- 2 files changed, 19 insertions(+), 7 deletions(-) create mode 100644 AUTHORS diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..7258415 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,19 @@ +Ben Mason +Dirk Moors +Gert Van Gool +Giovanni Collazo +Jakub Paczkowski +Jan Fabry +Jef Geskens +Jonathan Slenders +JoseĢ Padilla +Linsy Aerts +Maarten Timmerman +Niels Van Och +Olivier Sels +OpenShift guest +San Gillis +Simon Andersson +Steven Klass +sgillis +techdragon diff --git a/README.rst b/README.rst index f30a911..c4c770f 100644 --- 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 ----------- From 1ccfa7c917945a0e1a86eb1ea2af6d91158a12fa Mon Sep 17 00:00:00 2001 From: Gert Van Gool Date: Sat, 11 Apr 2015 14:47:52 +0200 Subject: [PATCH 6/6] Adds syntax highlighting on code blocks --- README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c4c770f..c40d13d 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ objects. Installation ------------ -:: +.. code:: sh pip install django-states @@ -72,7 +72,9 @@ Note: If you're creating a ``DataMigration`` in `South `__, remember to use ``obj.save(no_state_validation=True)`` -Usage example:: +Usage example: + +.. code:: python p = Purchase() @@ -125,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']