sphinxcontrib-django2 0.7

Installation

Usage:

pip install sphinxcontrib-django2

Add to the Sphinx config file (conf.py):

extensions = [
    'sphinx.ext.autodoc',
    'sphinxcontrib_django2',
]

Autodoc works by importing your code on the fly, and extracting the data from the Python classes. Thus, the project should be able to import Django models. Typically the following needs to be added to conf.py:

sys.path.insert(0, os.path.abspath('../src'))
os.environ['DJANGO_SETTINGS_MODULE'] = 'myapp.settings'
django.setup()

To support the :django:setting: role, configure Intersphinx:

intersphinx_mapping = {
    'http://docs.python.org/': None,
    'https://docs.djangoproject.com/en/stable': 'https://docs.djangoproject.com/en/stable/_objects',
}

Contributing

Pull requests are always welcome!

You can install all requirements of the development setup with Pipenv:

pipenv install --dev
pipenv run pre-commit install

Then, run the tests with:

pipenv run coverage run runtests.py