django-docs allows to serve Sphinx generated docs directly from Django.
Dependencies
Python 3.6+ for Django 3.0 or higher
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 = [ ... 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
Release files for django-docs 0.3.3
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.3.3.tar.gz | 7.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_docs-0.3.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.3 kB
Release files / django-docs-0.3.3.tar.gz
| Download URL | django-docs-0.3.3.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2b489ab122f6dc84a1a8f0e2be86dcc8b3958b31b2d0a4603570c47228408d0
|
|
BLAKE2b-256 checksum How to use checksums |
ba91571b5baf368ecf889472b0d4ca3cafe224add8544da6c05ee808c3de2d96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
Release files / django_docs-0.3.3-py3-none-any.whl
| Download URL | django_docs-0.3.3-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7e85c5b5dd0b9b4d24099740ab16ac0449ff8acdfe8b0e26c08f3a4e50e7e5e1
|
|
BLAKE2b-256 checksum How to use checksums |
c1cb69ea9a1b9af32b66cb2ecbeb4aae532a222dcf4bd8755f8e8054799819ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
