pax_global_header 0000666 0000000 0000000 00000000064 14504615222 0014513 g ustar 00root root 0000000 0000000 52 comment=91d3f8387de69dc190ad244120226b86e55dd3f9
sphinxcontrib-django-2.5/ 0000775 0000000 0000000 00000000000 14504615222 0015513 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/.github/ 0000775 0000000 0000000 00000000000 14504615222 0017053 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/.github/CODEOWNERS 0000664 0000000 0000000 00000000406 14504615222 0020446 0 ustar 00root root 0000000 0000000 # Each line is a file pattern followed by one or more owners.
# These owners will be the default owners for everything in the repo.
# Unless a later match takes precedence, they will be requested for review when someone opens a pull request.
* @timobrembeck
sphinxcontrib-django-2.5/.github/ISSUE_TEMPLATE/ 0000775 0000000 0000000 00000000000 14504615222 0021236 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/.github/ISSUE_TEMPLATE/bug-report.md 0000664 0000000 0000000 00000001613 14504615222 0023647 0 ustar 00root root 0000000 0000000 ---
name: "Bug report \U0001F41B"
about: "Create a report to help us improve"
labels: "bug"
---
### Describe the Bug
### Minimal Example to Reproduce
### Expected Behavior
### Actual Behavior
### Additional Information
Traceback
```
```
### System Information
OS version:
Python version:
Sphinx version:
sphinxcontrib_django version:
sphinxcontrib-django-2.5/.github/ISSUE_TEMPLATE/feature-request.md 0000664 0000000 0000000 00000001413 14504615222 0024700 0 ustar 00root root 0000000 0000000 ---
name: "Feature request \U0001F4A1"
about: "Suggest an idea for this project"
labels: "feature request"
---
### Motivation
### Proposed Solution
### Alternatives
### Additional Context
sphinxcontrib-django-2.5/.github/PULL_REQUEST_TEMPLATE.md 0000664 0000000 0000000 00000000371 14504615222 0022655 0 ustar 00root root 0000000 0000000 ### Short description
### Proposed changes
-
-
### Resolved issues
Fixes: #
sphinxcontrib-django-2.5/.github/workflows/ 0000775 0000000 0000000 00000000000 14504615222 0021110 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/.github/workflows/deployment.yml 0000664 0000000 0000000 00000002342 14504615222 0024014 0 ustar 00root root 0000000 0000000 name: Deployment
on: [push, pull_request]
jobs:
has:
name: Check Secrets
runs-on: ubuntu-latest
steps:
- id: secrets
env:
test_pypi_token: ${{ secrets.TEST_PYPI_TOKEN }}
pypi_token: ${{ secrets.PYPI_TOKEN }}
if: ${{ env.test_pypi_token != '' && env.pypi_token != '' }}
run:
echo "::set-output name=secrets::1"
outputs:
secrets: ${{ steps.secrets.outputs.secrets }}
build-and-publish:
needs: has
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- name: Install dependencies
run: pip install build twine
- name: Build a binary wheel and a source tarball
run: python3 -m build
- name: Publish distribution 📦 to Test PyPI
if: ${{ needs.has.outputs.secrets }}
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.TEST_PYPI_TOKEN }}
repository_url: https://test.pypi.org/legacy/
skip_existing: true
- name: Publish distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_TOKEN }}
sphinxcontrib-django-2.5/.github/workflows/linting.yml 0000664 0000000 0000000 00000001231 14504615222 0023274 0 ustar 00root root 0000000 0000000 name: Linting
on: [push, pull_request]
jobs:
black:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: psf/black@stable
isort:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: jamescurtin/isort-action@master
with:
configuration: --check-only
flake8:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- name: Install dependencies
run: pip install flake8 flake8-pyproject
- name: Run flake8
run: flake8 .
sphinxcontrib-django-2.5/.github/workflows/tests.yml 0000664 0000000 0000000 00000002250 14504615222 0022774 0 ustar 00root root 0000000 0000000 name: Tests
on: [push, pull_request]
jobs:
unittests:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
django-version: ["django~=3.2", "django~=4.1", "django~=4.2"]
optional-dependencies: ["optional-deps", "no-optional-deps"]
env:
OS: ubuntu-latest
PYTHON: ${{ matrix.python-version }}
DJANGO: ${{ matrix.django-version }}
steps:
- uses: actions/checkout@master
- name: Setup Python
uses: actions/setup-python@master
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install "${{ matrix.django-version }}"
pip install -e .[test]
- name: Install optional dependencies
if: matrix.optional-dependencies == 'optional-deps'
run: pip install -e .[optional]
- name: Run tests and generate coverage report
run: coverage run
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
env_vars: OS,PYTHON,DJANGO
name: codecov-umbrella
fail_ci_if_error: true
verbose: true
sphinxcontrib-django-2.5/.gitignore 0000664 0000000 0000000 00000000274 14504615222 0017506 0 ustar 00root root 0000000 0000000 *.pyc
*.pyo
*.mo
*.db
*.egg-info/
*.egg/
.coverage
.project
.idea/
.pydevproject
.idea/workspace.xml
.DS_Store
.venv/
.vscode/
build/
coverage.xml
dist/
docs/_build/
htmlcov/
__pycache__/
sphinxcontrib-django-2.5/.pre-commit-config.yaml 0000664 0000000 0000000 00000000506 14504615222 0021775 0 ustar 00root root 0000000 0000000 repos:
- repo: https://github.com/psf/black
rev: 23.1.0
hooks:
- id: black
- repo: https://github.com/PyCQA/isort
rev: 5.12.0
hooks:
- id: isort
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
- id: flake8
additional_dependencies:
- flake8-pyproject
sphinxcontrib-django-2.5/.readthedocs.yaml 0000664 0000000 0000000 00000000701 14504615222 0020740 0 ustar 00root root 0000000 0000000 # .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: true
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- doc
sphinxcontrib-django-2.5/AUTHORS 0000664 0000000 0000000 00000000152 14504615222 0016561 0 ustar 00root root 0000000 0000000 Original authors:
* Diederik van der Boor (@vdboor)
Maintainer since 2020:
* Timo Ludwig (@timoludwig)
sphinxcontrib-django-2.5/CHANGES.rst 0000664 0000000 0000000 00000012170 14504615222 0017316 0 ustar 00root root 0000000 0000000 Changelog
=========
Version 2.5 (2023-09-26)
------------------------
* Drop support for sphinx < 3.4.0
* [ `#45 `_ ] Fix rendering of inheritance diagrams
* Drop support for Python 3.7
Version 2.4 (2023-07-02)
------------------------
* [ `#39 `_ ] Fix table names of abstract models (`@insspb `__)
* [ `#41 `_ ] Fix rendering of iterable choices (`@insspb `__)
Version 2.3 (2023-04-12)
------------------------
* Add support for Django 4.2
* Drop support for Django 4.0
Version 2.2 (2023-03-01)
------------------------
* [ `#35 `_ ] Fix interference with other ``autodoc-skip-member`` signal handlers
Version 2.1 (2023-03-01)
------------------------
* [ `#32 `_ ] Fix rendering of nested directives in model parameter documentation
Version 2.0 (2023-01-02)
------------------------
Merge fork `sphinxcontrib_django2 `_ back into `sphinxcontrib_django `_.
*Versions 0.6 until 1.6 were releases of the fork. With version 2.0, the changes are included in the original package again.*
Version 1.6 (2022-11-24)
------------------------
* Add inline docstrings of model fields to parameter documentation of models
* Add support for Python 3.11
* Add support for Django 4.1
* Drop support for Django 2.2
Version 1.5 (2022-01-05)
------------------------
* Support string foreign keys of abstract models
Version 1.4 (2022-01-05)
------------------------
* Do not reference related names of abstract models
* Drop support for Python 3.6
* Drop support for Django 3.1
* Add support for Django 4.0
Version 1.3 (2021-11-20)
------------------------
* Fix ``AttributeError`` when ``django.contrib.contenttypes`` is not in ``INSTALLED_APPS``
* Emit sphinx event ``django-configured`` after ``django.setup()`` is finished to allow monkeypatching django during
documentation build
Version 1.2 (2021-11-08)
------------------------
* Add support for Python 3.10
* Add support for Django 3.2
* Drop support for Django 3.0
* Add option ``django_show_db_tables`` to list the database table names of Django models in their docstring
Version 1.1.1 (2021-03-02)
--------------------------
* Support django.db.models.JSONField
* List choices of choice fields
Version 1.1 (2021-03-02)
------------------------
* Add support for Python 3.9
* Add support for django-mptt with Django >=3.1
* Append initial docstrings to attributes
* Fix mutable references of pre-commit hooks
* Fix tests for sphinx 3.5.0
Version 1.0.2 (2021-02-02)
--------------------------
* Add support for GenericForeignKey field of django.contrib.contenttypes
Version 1.0.1 (2021-02-02)
--------------------------
* Fix Intersphinx mappings to AppConfig and Manager classes
Version 1.0 (2021-01-24)
------------------------
* Fix more Intersphinx mappings to Django classes
* Refactor package structure
* Refactor tests
* Improve docstring output
* Improve handling of related and reverse related fields
* Add documentation for sphinxcontrib_django itself
* Improve docstrings of iterable data
* Add config value for Django settings
* Load autodoc and intersphinx extensions in setup()
* Provide default intersphinx_mapping
* Return extension metadata in setup()
* Move dev dependencies from Pipfile to setup.py
* Add readthedocs.io integration
Version 0.7 (2020-11-30)
------------------------
* Fix Intersphinx mappings to Django classes
* 100% test coverage
Version 0.6 (2020-11-16)
------------------------
* Fix deferred attribute for Django >=2.1, <3.0
* Django: Drop support for [1.11, 2.0], add support for [2.2, 3.0, 3.1]
* Python: Drop support for [2.7, 3.5], add support for [3.6, 3.7, 3.8]
* Replace force_text by force_str (deprecated in Django 4.0)
* Improved test coverage
* Support for Django ModelFields
Version 0.5.1 (2020-01-26)
--------------------------
* Fix deferred attribute for Django 3.0.
Version 0.5 (2019-08-09)
------------------------
* Model fields always show verbose name if present.
* Model fields are skipped when they are already documented.
* Support "self" in foreign keys.
* Allow ``:setting:`` registration to fail
* Fixed ``runtests.py`` for Django 2.2
* Reformatted all source code with black, isort and flake8
Version 0.4 (2018-07-26)
------------------------
* Fixed Django 2.0 behavior when foreignkeys are strings.
Version 0.3.1 (2018-03-11)
--------------------------
* Fixed Python 2 issue with ``list.clear()``.
Version 0.3 (2018-02-19)
------------------------
* Fixed Django 2.0 support
* Fixed missing form fields
* Fixed handling of ``ForeignKey('modelname')``
Version 0.2.1 (2018-01-02)
------------------------
* Fixed bad packaging of 0.2
Version 0.2 (2018-01-02)
------------------------
* Support more Python versions (removed f-strings)
version 0.1 (2017-12-07)
------------------------
* Initial version
sphinxcontrib-django-2.5/LICENSE 0000664 0000000 0000000 00000026135 14504615222 0016527 0 ustar 00root root 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
sphinxcontrib-django-2.5/MANIFEST.in 0000664 0000000 0000000 00000000274 14504615222 0017254 0 ustar 00root root 0000000 0000000 include AUTHORS
include README.rst
include LICENSE
global-exclude .DS_Store
global-exclude Thumbs.db
global-exclude Desktop.ini
global-exclude *.swp
global-exclude *~
global-exclude *.bak
sphinxcontrib-django-2.5/README.rst 0000664 0000000 0000000 00000011023 14504615222 0017177 0 ustar 00root root 0000000 0000000 .. image:: https://github.com/edoburu/sphinxcontrib-django/workflows/Tests/badge.svg
:alt: GitHub Workflow Status
:target: https://github.com/edoburu/sphinxcontrib-django/actions?query=workflow%3ATests
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-django.svg
:alt: PyPi
:target: https://pypi.org/project/sphinxcontrib-django/
.. image:: https://codecov.io/gh/edoburu/sphinxcontrib-django/branch/main/graph/badge.svg
:alt: Code coverage
:target: https://codecov.io/gh/edoburu/sphinxcontrib-django
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Black Code Style
:target: https://github.com/psf/black
.. image:: https://img.shields.io/github/license/edoburu/sphinxcontrib-django
:alt: GitHub license
:target: https://github.com/edoburu/sphinxcontrib-django/blob/main/LICENSE
.. image:: https://readthedocs.org/projects/sphinxcontrib-django/badge/?version=latest
:alt: Documentation Status
:target: https://sphinxcontrib-django.readthedocs.io/en/latest/?badge=latest
|
.. image:: https://raw.githubusercontent.com/edoburu/sphinxcontrib-django/main/docs/images/django-sphinx-logo-blue.png
:width: 500
:alt: logo
:target: https://pypi.org/project/sphinxcontrib-django/
sphinxcontrib-django
=====================
This is a sphinx extension which improves the documentation of Django apps.
Features
--------
Improvements for the output of Sphinx's autodoc for Django classes:
* List all model and form fields as class parameters
* Improve model field representations
* Link related and reverse related fields to the referenced class
* Hide irrelevant runtime information like ``declared_fieldsets``, ``fieldsets`` and ``Meta`` from
classes
* Add information about autogenerated methods
* Fix intersphinx mappings to Django modules
* Custom text roles to cross-reference the documentations of Django (``:setting:``,
``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``) and Sphinx (``:event:``,
``:confval:``)
Installation
------------
Install the package via pip:
.. code-block:: bash
pip install sphinxcontrib-django
Configuration
-------------
Add the following to your Sphinx config file ``conf.py``:
.. code-block:: python
# Add source directory to sys.path
sys.path.insert(0, os.path.abspath("../src"))
# Add sphinxcontrib_django to installed extensions
extensions = [
"sphinxcontrib_django",
]
# Configure the path to the Django settings module
django_settings = "myapp.settings"
Optionally, you can include the table names of your models in their docstrings with:
.. code-block:: python
# Include the database table names of Django models
django_show_db_tables = True # Boolean, default: False
# Add abstract database tables names (only takes effect if django_show_db_tables is True)
django_show_db_tables_abstract = True # Boolean, default: False
Optionally, you can extend amount of displayed choices in model fields with them:
.. code-block:: python
# Integer amount of model field choices to show, default 10
django_choices_to_show = 10
Advanced Usage
--------------
If you want to run custom code which depends on Django, e.g. to monkeypatch your application during documentation build,
you might run into an `ImproperlyConfigured `_ exception:
Requested setting INSTALLED_APPS, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.
Therefore, this Sphinx extension emits the event ``django-configured`` after ``django.setup()`` is finished, so you can
run your code the following way in ``conf.py``:
.. code-block:: python
def patch_django(app):
"""
Your custom code here
"""
def setup(app):
app.connect("django-configured", patch_django)
Contributing
------------
Pull requests are always welcome!
You can install all requirements of the development setup with the extras ``dev``, ``test``, ``doc`` and ``optional``:
.. code-block:: bash
python3 -m venv .venv
source .venv/bin/activate
pip install -e .[dev,test,doc,optional]
pre-commit install
Run the tests and generate the coverage report with:
.. code-block:: bash
coverage run
coverage html
Build the documentation with:
.. code-block:: bash
cd docs
make html
The documentation is automatically deployed to `Read the Docs `_.
sphinxcontrib-django-2.5/docs/ 0000775 0000000 0000000 00000000000 14504615222 0016443 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/docs/Makefile 0000664 0000000 0000000 00000001172 14504615222 0020104 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
sphinxcontrib-django-2.5/docs/conf.py 0000664 0000000 0000000 00000003241 14504615222 0017742 0 ustar 00root root 0000000 0000000 # Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
from sphinxcontrib_django import __version__
# -- Project information -----------------------------------------------------
project = "sphinxcontrib-django"
copyright = "2021"
author = "Timo Ludwig"
# The full version, including alpha/beta/rc tags
release = __version__
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx_rtd_theme",
"sphinx_last_updated_by_git",
"sphinxcontrib_django.roles",
]
# Warn about all references where the target cannot be found
nitpicky = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ["templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages.
html_theme = "sphinx_rtd_theme"
# The logos shown in the menu bar
html_logo = "images/django-sphinx-logo-white.png"
# The favicon of the html doc files
html_favicon = "images/favicon.svg"
# Do not include links to the documentation source (.rst files) in build
html_show_sourcelink = False
sphinxcontrib-django-2.5/docs/docstrings.rst 0000664 0000000 0000000 00000002016 14504615222 0021353 0 ustar 00root root 0000000 0000000 Docstrings
==========
.. automodule:: sphinxcontrib_django.docstrings
:members:
:undoc-members:
:show-inheritance:
Field Utilities
---------------
.. automodule:: sphinxcontrib_django.docstrings.field_utils
:members:
:undoc-members:
:show-inheritance:
Attributes
----------
.. automodule:: sphinxcontrib_django.docstrings.attributes
:members:
:undoc-members:
:show-inheritance:
Classes
-------
.. automodule:: sphinxcontrib_django.docstrings.classes
:members:
:undoc-members:
:show-inheritance:
Data
----
.. automodule:: sphinxcontrib_django.docstrings.data
:members:
:undoc-members:
:show-inheritance:
Methods
-------
.. automodule:: sphinxcontrib_django.docstrings.methods
:members:
:undoc-members:
:show-inheritance:
Patches
-------
.. automodule:: sphinxcontrib_django.docstrings.patches
:members:
:undoc-members:
:show-inheritance:
Config
------
.. automodule:: sphinxcontrib_django.docstrings.config
:members:
:undoc-members:
:show-inheritance:
sphinxcontrib-django-2.5/docs/images/ 0000775 0000000 0000000 00000000000 14504615222 0017710 5 ustar 00root root 0000000 0000000 sphinxcontrib-django-2.5/docs/images/django-sphinx-logo-black.png 0000664 0000000 0000000 00000222504 14504615222 0025204 0 ustar 00root root 0000000 0000000 PNG
IHDR ^A zTXtRaw profile type exif xڥivdv3
á]3m"TM:m*2t/Nw߯7J-Ru3W/|~??_{-V5}~ /} 4#Ma߁R!|eyu |^N?R,g_+ۅ7S'SL ΅!U~O3K' _]M5g_eߘ_K߾B}V^ܾſ W(}nUlھY&УcjF5xwQՋm{ "! FSHb Fz\I7VrS#ɋ'ލ%v{Z;pi zýjKK/VQfʜ~r `Q"? D'.,~% d ZH%X5l$h0rd 79%#7-Rû4ێ32QgM]Fr.O͍%\J1^%V̬@qTZ^GK-ҬZoǞ ҭzcȃ1L3:s,gUk?{p(O9viq)ͷ\#kߴZ|҅n?CIQHXt9PQ9- 9HW$r2F ;?U_ys5-o9.k[4 Յ
Ot 㵏sz\6g;}m:y": ,'z.;o;ϭ%]+)cB}uv|+]C
%:i3l?a*]h> __k<k2Hg [a)c wz{S,Kq! $n\V6S@Ɋ.*&S^Tv2ן #uINX>s*e]M4FN8q^c\&=*j(u' D|v[3Tb:9 VOXκ 0a ՚EلBWK;2vKK˒yj>W!vffOQ-:.)ᵞ|nHa54*yZ+q֧rt!wCؾ[O~K4>3 X@k ( ^'^'`} [1Cb12 >|+@SJޘ$KD%/pu<i5今 Ƕ̣.?: ~ #yQ!LA9Lp~Bp °Ya%[ՈE>0 BKK{:Ai ~`gPf =q! hPTtrCC+ hHՀ P6[}.=w R&@m0h9$Jd V@`%CʬޑW0J
=
):6S#cej*E 8_V&Eo9F#܃PiSj}Q@Y" ʳz,=W s}0~Z7V#_&AS C
aRHIԵ6kT%&|L I Ɠߦu!QzV/rcD;h<-n
#́"MC@;jTVQq:#e%cщ0ɼQmӢ {l,f^b>76gr 5zl3.FT:grW:"fX OnBDǔ8H*d174UBQDN$cyݥ@/fGU*W.6})'@YRv&Q6)8K/.|d9p* G_z"j AV
sgrCWpyy92X?jZ1 aҾ(f|խQ܈y ߾jUpf$A%F J
߷D}a% N^PrkA $OO}H 54"xMuTn0 y$8 ӒJVY 2}H<Рp'(G?tWPS#) 11RO8]DI #6Vne>|gsM`فUV FL,[1ӑT%1HG嵹vqW'G[܈+4sN#T8JoG4lk3u,׳^aԏ^ƃ.7H,/f%'J v # Z\VcxhbZN/)_Pb\ ڲt6"IL
Ġ"`kBM%Ǫ}TDN\m3 *Y(>^jBo&xpmSO`*Ԍ~\F{ 3[hm
h H=܅?q!~̼~>oA&"aa\GE191$h߇2,n)jR hd'aldYN^ +
]Bz|G at'_<%#PT@z'j_ Ȇa4JH
ԮM Fku z|P~ joĄX*^
ͮPrCaavm imHp'k?G>;wO㻣Aq Gv z2LQ?ĵ4+c R 0 D{b{e aHI$a`8 . )cO2:
"[(vUq״91
0MCvn%RTw\ND P=W|tEՂyӎ2=D oJ҃1Zi m
،r;> ٌ iɁW
~^Æ q
ph'e|(7}x"NQ, +h+ ԩDZ _w rj/9D(*Xo EE$0 $!}} G\&'KsҶVW}":A扄 k ӠjX|> YyQ4?MAb t_|4(F[HS B9feEQ_κ ^O {2<֖ X5SK*TШ]d;zJ>j{
(` G =U+6)'Cj,Ki7ȚQxmFޮB}6%Ђ J I 6, Cb,?T#n6@>] @5(^t 5Groiy19'#wcL "t<
bo'Ik6E˧g.-Ԕ ᫃%F pZanDza A.T[<<>'pҴ1A (Fmv 1u!j:-3:ZNWa?[C6D* 8鼠|sښ5Vx"QG8Uk݁EHxtᝐ50c8mK8{>ߢɣ22y"Ny@"@Nu6!"fC?xaF*&!j#-.g0&-t0 hQ&Ip Β6%9aXMHGƗR%;n4dƤiGZ G쒌\r| o&F.P }ܫ qf$E!BQ $6^fJ,mLG(.23+T$tu4Fs
49^ Rt-7 S FvN0@{JcQN,u Ȣ}Xj0 8(k"'/:4>Q{72G(
˹qv6e:CP*oD(
h,2]@N3mt&DīeD>O}| L Zݯw IH6N4&RN *@@ @W :ANvQu@eC {o? \0֨/ Gka&q v)cG(^#j:PMrmUvNA)xuΦߣca})FOq
tKAF&AH@c_%&`l:$C gՄҎWSAh]6p7Z>̨Cg "̐0| ۉR)h놮ɽ.Bjv} D'2 /<6$)q%awNVDҔ}Ϛv"@y8%Zx!@ؔFТVY xo&J6yc$)ƣpZ,D[4tԧ[H,d;N'$1C d_mH
J=AGgĮOhʛ82xC#,@#
2:sO2G SlȈng5 GZ1! G?L ̋vciK[+ :[j>}I7=
-(Ё1"КzP\(đ#"҃>md±= ڰ@!+,@Ӄtz$v_5K) }!Llk #% It +}OZ
SVNeѕSw<l (M}fџr$XKxpO 59N$˨(CMȔvXQh j=dG,n
``^?W Nꬬ%)- 9 FS
Z] Zʸ_7dRTQU똍HAU`t!.P'i ^T iCCPICC profile x}=H@ _S;8dh,8jP!
:\MGbYWWA qssRtZxpw w Vb1hm&11YA `\f1'I x{zY jbO$eioOo}+*9I$~7y2SyocYԈêSnyV= Y}e4" A
(FV Iڏy\D.\E0r,
ZɉFR0t8G| ;N?Wz_3W[Z.[\ Olʮ)r}S5q
pp){]{Jrw@]
iTXtXML:com.adobe.xmp
{ bKGD pHYs tIME '1g8 IDATxۏ\goUIDQF3##{4\70 2 ? @6f|{_d} @{2IF'clIr<-fkCWSUk~y$I$I$iK]~uL vkhM I$I$I߹%W tje $I$I$mVP#tXY]wC on-!I$I$I?w>uKHک %I$I$IYXu+H %I$I$I;nI;$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
g((I$I$I$5$I$I$Ip$I$I$IR
J$I$I$I
7&m$-bW^V _$I$I$
CAI {Oy00 +˱,$I$Ic((IϯMhuSUח6ͥ
0v |M%* w^> A~O<,C$I$I
JiQsZׁDMXx
濷kD-B뗁[MZD% >
{ J$I$I+a((ika$QscD5LT
a<
Q X̀m A DȷJ:}pJD%ჼ]R[R$I$Iݠ6V
! Q6
ETa8#" õǭn6 Qw a_ r<1)~t.GUU$I$I %5Q;orLQ` _?w&_?J 땂~'nw@ *Ep0O߹\$Ƶ>CBI$I$IzNvzU_}J j㹗 rC7:%d}U"{DT> B/;D5QY0_B Tk$n:$I$I]PPNWaok|vʏES+5K%5
o7Dua ,$I$I9 .i싆nh9S9ƉJT~
T u)ܹ֞T-GT-S]!BE",r>w#JT .|ot5H$I$Ij2CAI;('*Gj1"j.-E5J;I=Gz(a`>s_#B&
J$I$Ij4CAI/[iYBD$ gpXn6oǨoR>:t 8 Մw{& $I$I4 %m{-FP,&Qx2 ﭽnͨ-z/vjǺמҊt |AT^~OT>&Z>$RQX %I$I$i3CիfDD\>7E~D`Y/ppͩm4n gs ph5zH&-Մ2 $I$I
Jz^
psQUYDȲpN8dW>-^>ϱB1UE
na}CI$I$Iz %=6M~oX 1MT NA0UEVͨc|awi#2ъ>)%I$I$J5j9""Dcy=(z kU#D%\>#*WD0x% *eN>~z$I$IDw8'DU`G+!Agڅ.k/.UQI$I$IPºs!#9横5{Ǩvg
"gͱh!z16mjQ5H0!QQx %I$I$m!CAyJ_o <
*'X(
S :#"QZ>ֈ2J5a$I$IPPj1";@} q0cv;^
au#D(X%z