Allows to serve Sphinx generated docs from django.
Credits
Project on GitHub: littlepea/django-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 = patterns('', ... 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
You can run the tests with via:
python setup.py test
or:
python docs/tests/runtests.py
Release files for django-docs 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-docs-0.1.1.tar.gz | 9.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_docs-0.1.1-py2.7.egg | Legacy Egg format | - | - | Details |
Total release size: 29.2 kB
Release files / django-docs-0.1.1.tar.gz
| Download URL | django-docs-0.1.1.tar.gz |
|---|---|
| Size | 9.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
12eac78c1b928faf356e032f93c6757ea697912c1a95871c7ec78b704b6d5755
|
|
BLAKE2b-256 checksum How to use checksums |
e71ddbbfd2c006b143556ef885438282d551a1314818009ac99fa2c412b9ae53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / django_docs-0.1.1-py2.7.egg
| Download URL | django_docs-0.1.1-py2.7.egg |
|---|---|
| Size | 20.1 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
5579633c9027e6f108b4f4bf26c7d06b7ab77c6fcb2d64068122e8dbd1f1c8fe
|
|
BLAKE2b-256 checksum How to use checksums |
660bee9cb6a3d6b28fcf202270bfefe026a954af895a1a085b2aabbba5fe03d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
