Sphinx Django Command
Add you Django Command’s help to your documentation. Just write:
.. djcommand:: myapp.management.commands.mycmd
And you’ll have:
Usage: manage.py mycmd [options] Options: --version show program's version number and exit -h, --help show this help message and exit
Useful to keep DRY documentation between Sphinx and your command help.
Setup
Install with:
pip install sphinx-django-command
Be sure your Sphinx conf.py has access to the command that you want to document, the app could be found in sys.path and DJANGO_SETTINGS_MODULE is available if necessary.
Insert 'djcommanddoc' in the extensions parameter:
extensions = [ ... 'djcommanddoc', ... ]
Tests
Tests are stored in djcommanddoc.tests and for run them you must launch:
python djcommanddoc/tests.py
To run the tests across all supported versions of Django and Python, you can use Tox. Firstly install Tox:
pip install tox
To run the tests just use the command tox in the command line. If you want to run the tests against just one specific test environment you can run tox -e <testenv>. For example, to run the tests with Python3.3 and Django1.9 you would run:
tox -e py3.3
The available test environments can be found in tox.ini.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-django-command 0.1.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 | |
|---|---|---|---|
| sphinx-django-command-0.1.3.tar.gz | 4.1 kB | Details |
Release files / sphinx-django-command-0.1.3.tar.gz
| Download URL | sphinx-django-command-0.1.3.tar.gz |
|---|---|
| Size | 4.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
837adc9146c51c7a35768e9b2f3f544056a39d0616d72550f957282cd8c678fa
|
|
BLAKE2b-256 checksum How to use checksums |
ef853a520be5d30f6b65ab60a76018ed40226ddc6b305f6b59987eb4879d5ac4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
