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
Screenshot
Release files for django-docs 0.1.2
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.2.tar.gz | 9.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_docs-0.1.2-py2.7.egg | Legacy Egg format | - | - | Details |
Total release size: 29.4 kB
Release files / django-docs-0.1.2.tar.gz
| Download URL | django-docs-0.1.2.tar.gz |
|---|---|
| Size | 9.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e0a416253e0ac60c3d8f3d823e4da1d93df2fa9efbe54cb11e2829df71dffec2
|
|
BLAKE2b-256 checksum How to use checksums |
eee08e988718e8a9eb8304c0ac1078e784032404604633d3c565a0a4ddb60837
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / django_docs-0.1.2-py2.7.egg
| Download URL | django_docs-0.1.2-py2.7.egg |
|---|---|
| Size | 20.2 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
8c76405b0eb8b1e4968055aef19fb0be5ffef204bdc4a9767a90775b92c09d2a
|
|
BLAKE2b-256 checksum How to use checksums |
1a0a0f876f8023f0e3ec5d7108f4a0adeb694e36b6eebc86b67880e5406a7f1c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
