Fix somme RST errors in README.rst. Add a test in tox.ini to detect such errors
This commit is contained in:
parent
e3ab64271b
commit
c2b146335f
3 changed files with 37 additions and 28 deletions
|
@ -5,6 +5,7 @@ env:
|
||||||
matrix:
|
matrix:
|
||||||
- TOX_ENV=coverage
|
- TOX_ENV=coverage
|
||||||
- TOX_ENV=flake8
|
- TOX_ENV=flake8
|
||||||
|
- TOX_ENV=check_rst
|
||||||
- TOX_ENV=py27-django17
|
- TOX_ENV=py27-django17
|
||||||
- TOX_ENV=py27-django18
|
- TOX_ENV=py27-django18
|
||||||
- TOX_ENV=py27-django19
|
- TOX_ENV=py27-django19
|
||||||
|
|
18
README.rst
18
README.rst
|
@ -22,11 +22,11 @@ CAS Server is a Django application implementing the `CAS Protocol 3.0 Specificat
|
||||||
By defaut, the authentication process use django internal users but you can easily
|
By defaut, the authentication process use django internal users but you can easily
|
||||||
use any sources (see auth classes in the auth.py file)
|
use any sources (see auth classes in the auth.py file)
|
||||||
|
|
||||||
The defaut login/logout template use `django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`_
|
The defaut login/logout template use `django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`__
|
||||||
but you can use your own templates using settings variables.
|
but you can use your own templates using settings variables.
|
||||||
|
|
||||||
Note that for Django 1.7 compatibility, you need a version of
|
Note that for Django 1.7 compatibility, you need a version of
|
||||||
`django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`_ < 7.0.0
|
`django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`__ < 7.0.0
|
||||||
like the 6.2.2 version.
|
like the 6.2.2 version.
|
||||||
|
|
||||||
Features
|
Features
|
||||||
|
@ -43,7 +43,7 @@ Features
|
||||||
|
|
||||||
Quick start
|
Quick start
|
||||||
-----------
|
-----------
|
||||||
0. If you want to make a virtualenv for ``django-cas-server``, you will need the following
|
1. If you want to make a virtualenv for ``django-cas-server``, you will need the following
|
||||||
dependencies on a bare debian like system::
|
dependencies on a bare debian like system::
|
||||||
|
|
||||||
virtualenv build-essential python-dev libxml2-dev libxslt1-dev zlib1g-dev
|
virtualenv build-essential python-dev libxml2-dev libxslt1-dev zlib1g-dev
|
||||||
|
@ -53,7 +53,7 @@ Quick start
|
||||||
If you intend to run the tox tests you will also need ``python3.4-dev`` depending of the current
|
If you intend to run the tox tests you will also need ``python3.4-dev`` depending of the current
|
||||||
version of python3 on your system.
|
version of python3 on your system.
|
||||||
|
|
||||||
1. Add "cas_server" to your INSTALLED_APPS setting like this::
|
2. Add "cas_server" to your INSTALLED_APPS setting like this::
|
||||||
|
|
||||||
INSTALLED_APPS = (
|
INSTALLED_APPS = (
|
||||||
'django.contrib.admin',
|
'django.contrib.admin',
|
||||||
|
@ -71,7 +71,7 @@ Quick start
|
||||||
...
|
...
|
||||||
)
|
)
|
||||||
|
|
||||||
2. Include the cas_server URLconf in your project urls.py like this::
|
3. Include the cas_server URLconf in your project urls.py like this::
|
||||||
|
|
||||||
urlpatterns = [
|
urlpatterns = [
|
||||||
url(r'^admin/', admin.site.urls),
|
url(r'^admin/', admin.site.urls),
|
||||||
|
@ -79,10 +79,10 @@ Quick start
|
||||||
url(r'^cas/', include('cas_server.urls', namespace="cas_server")),
|
url(r'^cas/', include('cas_server.urls', namespace="cas_server")),
|
||||||
]
|
]
|
||||||
|
|
||||||
3. Run `python manage.py migrate` to create the cas_server models.
|
4. Run `python manage.py migrate` to create the cas_server models.
|
||||||
|
|
||||||
|
|
||||||
4. You should add some management commands to a crontab: ``clearsessions``,
|
5. You should add some management commands to a crontab: ``clearsessions``,
|
||||||
``cas_clean_tickets`` and ``cas_clean_sessions``.
|
``cas_clean_tickets`` and ``cas_clean_sessions``.
|
||||||
|
|
||||||
* ``clearsessions``: please see `Clearing the session store <https://docs.djangoproject.com/en/stable/topics/http/sessions/#clearing-the-session-store>`_.
|
* ``clearsessions``: please see `Clearing the session store <https://docs.djangoproject.com/en/stable/topics/http/sessions/#clearing-the-session-store>`_.
|
||||||
|
@ -102,11 +102,11 @@ Quick start
|
||||||
*/5 * * * * cas-user /path/to/project/manage.py cas_clean_tickets
|
*/5 * * * * cas-user /path/to/project/manage.py cas_clean_tickets
|
||||||
5 0 * * * cas-user /path/to/project/manage.py cas_clean_sessions
|
5 0 * * * cas-user /path/to/project/manage.py cas_clean_sessions
|
||||||
|
|
||||||
5. Start the development server and visit http://127.0.0.1:8000/admin/
|
6. Start the development server and visit http://127.0.0.1:8000/admin/
|
||||||
to add a first service allowed to authenticate user agains the CAS
|
to add a first service allowed to authenticate user agains the CAS
|
||||||
(you'll need the Admin app enabled).
|
(you'll need the Admin app enabled).
|
||||||
|
|
||||||
6. Visit http://127.0.0.1:8000/cas/ to login with your django users.
|
7. Visit http://127.0.0.1:8000/cas/ to login with your django users.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
8
tox.ini
8
tox.ini
|
@ -1,6 +1,7 @@
|
||||||
[tox]
|
[tox]
|
||||||
envlist=
|
envlist=
|
||||||
flake8,
|
flake8,
|
||||||
|
check_rst,
|
||||||
py27-django17,
|
py27-django17,
|
||||||
py27-django18,
|
py27-django18,
|
||||||
py27-django19,
|
py27-django19,
|
||||||
|
@ -60,6 +61,13 @@ basepython=python
|
||||||
deps=flake8
|
deps=flake8
|
||||||
commands=flake8 {toxinidir}/cas_server
|
commands=flake8 {toxinidir}/cas_server
|
||||||
|
|
||||||
|
[testenv:check_rst]
|
||||||
|
basepython=python
|
||||||
|
deps=
|
||||||
|
docutils
|
||||||
|
Pygments
|
||||||
|
commands=python {toxinidir}/setup.py check --restructuredtext --stric
|
||||||
|
|
||||||
[testenv:coverage]
|
[testenv:coverage]
|
||||||
basepython=python
|
basepython=python
|
||||||
passenv=CODACY_PROJECT_TOKEN
|
passenv=CODACY_PROJECT_TOKEN
|
||||||
|
|
Loading…
Reference in a new issue