django-docs 0.3.0

Dependencies

• Python 2.7-3.6 for Django 1.8 - 1.11

• Python 3.4-3.6 for Django 2.0 or higher

Credits

• Project on GitHub: littlepea/django-docs

• Documentation on Read The Docs

• Maintained by Evgeny Demchenko

Installation

1. Install django-docs package:

   pip install django-docs

2. Add docs to INSTALLED_APPS in settings.py:

   INSTALLED_APPS = (
       ...
       'docs',
       ...
   )

3. Add docs.urls to urls.py:

   urlpatterns = [
       ...
       url(r'^docs/', include('docs.urls')),
       ...
   ]

4. Customize configuration:

   DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html')
   DOCS_ACCESS = 'staff'

Configuration

Running the tests

Make sure to install test_requirements.txt first:

pip install -r test_requirements.txt
pip install -e .

You can run the tests with via:

python setup.py test

or:

python docs/tests/runtests.py

To run all tests against different versions of Django simply run:

tox

Running the example project

Make sure to install requirements.txt first:

virtualenv env
. env/bin/activate
pip install -r test_requirements.txt
pip install -e .

You can run the example project with via:

cd example
python manage.py migrate
python manage.py runserver

Screenshot