Allows to serve Sphinx generated docs from django.
Project description
django-docs allows to serve Sphinx generated docs directly from Django.
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
Install django-docs package:
pip install django-docs
Add docs to INSTALLED_APPS in settings.py:
INSTALLED_APPS = ( ... 'docs', ... )
Add docs.urls to urls.py:
urlpatterns = [ ... url(r'^docs/', include('docs.urls')), ... ]
Customize configuration:
DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html') DOCS_ACCESS = 'staff'
Configuration
DOCS_ROOT (required)
Absolute path to the root directory of html docs generated by Sphinx (just like STATIC_ROOT / MEDIA_ROOT settings).
DOCS_ACCESS (optional)
Docs access level (public by default). Possible values:
- public - (default) docs are visible to everyone
- login_required - docs are visible only to authenticated users
- staff - docs are visible only to staff users (user.is_staff == True)
- superuser - docs are visible only to superusers (user.is_superuser == True)
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size django_docs-0.3.1-py3-none-any.whl (8.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size django-docs-0.3.1.tar.gz (6.7 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for django_docs-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b233e0b30e2ad417787f0276c3750c90ed9d00cbb3bec1b63f10028c06e5bcdc |
|
MD5 | 266b4ae4a5d26968e564894598985177 |
|
BLAKE2-256 | 60a3e5911935c9476850d9c828cdcd5f36c3e3c4b09f6ed087d361e0dfdda238 |