Merge pull request #546 from gwasser/new0.2release

Update docs for minimum of Django 1.11, set release version to 0.2.0 …
This commit is contained in:
Garret Wassermann 2017-08-30 16:00:08 -04:00 committed by GitHub
commit 866a1bc72a
8 changed files with 24 additions and 25 deletions

View File

@ -2,15 +2,12 @@ language: python
python: python:
- "2.7" - "2.7"
- 3.4.4 - "3.4"
- "3.5" - "3.5"
- "3.6" - "3.6"
env: env:
- DJANGO=1.8.18 - DJANGO=1.11.4
- DJANGO=1.9.13
- DJANGO=1.10.7
- DJANGO=1.11
install: install:
- pip install -q Django==$DJANGO - pip install -q Django==$DJANGO

View File

@ -7,7 +7,7 @@ django-helpdesk - A Django powered ticket tracker for small businesses.
.. image:: https://codecov.io/gh/django-helpdesk/django-helpdesk/branch/master/graph/badge.svg .. image:: https://codecov.io/gh/django-helpdesk/django-helpdesk/branch/master/graph/badge.svg
:target: https://codecov.io/gh/django-helpdesk/django-helpdesk :target: https://codecov.io/gh/django-helpdesk/django-helpdesk
Copyright 2009- Ross Poulton and contributors. All Rights Reserved. Copyright 2009-2017 Ross Poulton and django-helpdesk contributors. All Rights Reserved.
See LICENSE for details. See LICENSE for details.
django-helpdesk was formerly known as Jutda Helpdesk, named after the django-helpdesk was formerly known as Jutda Helpdesk, named after the
@ -61,8 +61,13 @@ to alert you to this shortcoming. There is no way around it, sorry.
Installation Installation
------------ ------------
django-helpdesk requires either Python 2.7 or 3.4+, as well as Django 1.8+. django-helpdesk requires either Python 2.7 or 3.4+, as well as Django 1.11+.
The recommended combination is Python 3.4+ with Django 1.10.
**NOTE REGARDING PYTHON VERSION:**
The recommended combination is Python 3.4+ with Django 1.11+.
Support for Python 2 will end in the next versions of both django-helpdesk
and Django itself (2.0), so users and developers are encouraged to begin
transitioning to Python 3 if have not already.
You can quickly install the latest stable version of django-helpdesk app via pip: You can quickly install the latest stable version of django-helpdesk app via pip:

View File

@ -73,7 +73,7 @@ Then navigate to the site in a browser as above.
*NOTE ON DJANGO VERISON* *NOTE ON DJANGO VERISON*
The demo project was also created with Django 1.10 The demo project was also created with Django 1.11
in mind. If you are using a different version of Django, in mind. If you are using a different version of Django,
slight tweaks might be necessary to make the demo work. slight tweaks might be necessary to make the demo work.

View File

@ -41,16 +41,16 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'django-helpdesk' project = u'django-helpdesk'
copyright = u'2011, Ross Poulton + Contributors' copyright = u'2011-2017, Ross Poulton + django-helpdesk Contributors'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.1' version = '0.2'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1' release = '0.2.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -179,7 +179,7 @@ htmlhelp_basename = 'django-helpdeskdoc'
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'django-helpdesk.tex', u'django-helpdesk Documentation', ('index', 'django-helpdesk.tex', u'django-helpdesk Documentation',
u'Ross Poulton + Contributors', 'manual'), u'Ross Poulton + django-helpdesk Contributors', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -212,5 +212,5 @@ latex_documents = [
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'django-helpdesk', u'django-helpdesk Documentation', ('index', 'django-helpdesk', u'django-helpdesk Documentation',
[u'Ross Poulton + Contributors'], 1) [u'Ross Poulton + django-helpdesk Contributors'], 1)
] ]

View File

@ -10,13 +10,13 @@ Contents
:maxdepth: 2 :maxdepth: 2
:glob: :glob:
license
install install
configuration configuration
settings settings
spam spam
custom_fields custom_fields
contributing contributing
license
How Does It Look? How Does It Look?
@ -69,7 +69,7 @@ django-helpdesk is released under the BSD license, however it packages 3rd party
Dependencies Dependencies
------------ ------------
1. Python 2.7+ (or 3.4+) 1. Python 3.4+ (or 2.7, but deprecated and support will be removed next release)
2. Django (1.8 or newer) 2. Django 1.11 or newer
3. An existing **working** Django project with database etc. If you cannot log into the Admin, you won't get this product working! This means you **must** run `syncdb` **before** you add ``helpdesk`` to your ``INSTALLED_APPS``. 3. An existing **working** Django project with database etc. If you cannot log into the Admin, you won't get this product working! This means you **must** run `syncdb` **before** you add ``helpdesk`` to your ``INSTALLED_APPS``.

View File

@ -63,7 +63,7 @@ errors with trying to create User settings.
This line will have to come *after* any other lines in your urls.py such as those used by the Django admin. This line will have to come *after* any other lines in your urls.py such as those used by the Django admin.
Note that the `helpdesk` namespace is no longer required for Django 1.9 and you can use a different namespace. Note that the `helpdesk` namespace is no longer required for Django 1.9+ and you can use a different namespace.
However, it is recommended to use the default namespace name for clarity. However, it is recommended to use the default namespace name for clarity.
3. Create the required database tables. 3. Create the required database tables.

View File

@ -1,4 +1,4 @@
Django>=1.8 Django>=1.11
django-bootstrap-form>=3.1,<4 django-bootstrap-form>=3.1,<4
email-reply-parser email-reply-parser
django-markdown-deux django-markdown-deux

View File

@ -6,7 +6,7 @@ from distutils.util import convert_path
from fnmatch import fnmatchcase from fnmatch import fnmatchcase
from setuptools import setup, find_packages from setuptools import setup, find_packages
version = '0.2.0.1' version = '0.2.0'
# Provided as an attribute, so you can append to these instead # Provided as an attribute, so you can append to these instead
# of replicating them: # of replicating them:
@ -133,9 +133,6 @@ setup(
"Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.6",
"Framework :: Django", "Framework :: Django",
"Framework :: Django :: 1.8",
"Framework :: Django :: 1.9",
"Framework :: Django :: 1.10",
"Framework :: Django :: 1.11", "Framework :: Django :: 1.11",
"Environment :: Web Environment", "Environment :: Web Environment",
"Operating System :: OS Independent", "Operating System :: OS Independent",
@ -150,8 +147,8 @@ setup(
'cases', 'bugs', 'track', 'support'], 'cases', 'bugs', 'track', 'support'],
author='Ross Poulton', author='Ross Poulton',
author_email='ross@rossp.org', author_email='ross@rossp.org',
maintainer='Jonathan Barratt', maintainer='Garret Wassermann',
maintainer_email='jonathan@the-im.com', maintainer_email='gwasser@gmail.com',
url='https://github.com/django-helpdesk/django-helpdesk', url='https://github.com/django-helpdesk/django-helpdesk',
license='BSD', license='BSD',
packages=find_packages(), packages=find_packages(),