Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Commit

Permalink
Documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
mrogaski committed Aug 19, 2016
1 parent edb3fb5 commit d35a7fd
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 42 deletions.
36 changes: 5 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
===================
django-discord-bind
===================

*A Django app for securely associating a user with a Discord account.*

.. image:: https://badge.fury.io/py/django-discord-bind.svg
:target: https://badge.fury.io/py/django-discord-bind
:alt: Git Repository
.. image:: https://travis-ci.org/mrogaski/django-discord-bind.svg?branch=master
:target: https://travis-ci.org/mrogaski/django-discord-bind

:alt: Build Status
.. image:: https://readthedocs.org/projects/django-discord-bind/badge/?version=latest
:target: http://django-discord-bind.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

This is a simple Django application that allows users to associate one or
more Discord accounts to their Django accounts and automatically join a
Expand All @@ -21,35 +24,6 @@ Requirements
* Python 2.7, 3.4, 3.5
* Django 1.9, 1.10


Installation
------------

Install with pip::

pip install django-discord-bind

Add `discord_bind` to your `INSTALLED_APPS` setting:

.. code-block:: python
INSTALLED_APPS = [
...
'discord_bind',
]
Include the URL configuration in your project **urls.py**:

.. code-block:: python
urlpatterns = [
...
url(r'^discord/', include('discord_bind.urls')),
]
Run ``python manage.py migrate`` to create the discord_bind models.


License
-------

Expand Down
7 changes: 6 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Change Log

This project uses `Semantic Versioning <http://semver.org/>`__.

0.2.0 -- unreleased
0.2.0 -- 2016-08-19
-------------------

Added
Expand All @@ -12,6 +12,11 @@ Added
- Added the DISCORD_REDIRECT_URI setting.
- Added state validation to prevent CSRF attacks.

Updated
~~~~~~~

- Added more documentation.

0.1.3 -- 2016-08-14
-------------------

Expand Down
16 changes: 10 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
#
# django-discord-bind documentation build configuration file, created by
# sphinx-quickstart on Wed Aug 17 18:11:27 2016.
# sphinx-quickstart on Fri Aug 19 01:33:24 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
Expand Down Expand Up @@ -57,10 +57,14 @@
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.2'
# The full version, including alpha/beta/rc tags.
release = '0.2.0'
try:
from discord_bind import __version__
# The short X.Y version.
version = '.'.join(__version__.split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = __version__
except ImportError:
version = release = 'dev'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -120,7 +124,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'default'

# 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
Expand Down
7 changes: 3 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. include:: ../README.rst


Contents:
=========
Contents
========

.. toctree::
:maxdepth: 1

installation
settings
changelog

Expand All @@ -17,4 +17,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

28 changes: 28 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _installation:

Installation
------------

Install with pip::

pip install django-discord-bind

Add `discord_bind` to your `INSTALLED_APPS` setting:

.. code-block:: python
INSTALLED_APPS = [
...
'discord_bind',
]
Include the URL configuration in your project **urls.py**:

.. code-block:: python
urlpatterns = [
...
url(r'^discord/', include('discord_bind.urls')),
]
Run ``python manage.py migrate`` to create the discord_bind models.

0 comments on commit d35a7fd

Please sign in to comment.