Merge fork sphinxcontrib-django2 back into original package

Versions 0.6 until 1.6 were releases of the fork:

- https://github.com/timoludwig/sphinxcontrib-django2
- https://pypi.org/project/sphinxcontrib-django2/

Author: timobrembeck

AUTHORS

@@ -2,6 +2,6 @@ Original authors:
 
 * Diederik van der Boor (@vdboor)
 
-Maintainer of this fork:
+Maintainer since 2020:
 
 * Timo Ludwig (@timoludwig)

CHANGES.rst

@@ -4,6 +4,8 @@ Changelog
 Version 1.6 (2022-11-24)
 ------------------------
 
+*Versions 0.6 until 1.6 were releases of the fork* `sphinxcontrib_django2 <https://pypi.org/project/sphinxcontrib-django2/>`_.
+
 * Add inline docstrings of model fields to parameter documentation of models
 * Add support for Python 3.11
 * Add support for Django 4.1
@@ -79,7 +81,7 @@ Version 1.0 (2021-01-24)
 * Refactor tests
 * Improve docstring output
 * Improve handling of related and reverse related fields
-* Add documentation for sphinxcontrib_django2 itself
+* Add documentation for sphinxcontrib_django itself
 * Improve docstrings of iterable data
 * Add config value for Django settings
 * Load autodoc and intersphinx extensions in setup()
@@ -97,7 +99,7 @@ Version 0.7 (2020-11-30)
 
 
 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]

README.rst

@@ -1,30 +1,30 @@
-.. image:: https://github.com/timoludwig/sphinxcontrib-django2/workflows/Tests/badge.svg
+.. image:: https://github.com/edoburu/sphinxcontrib-django/workflows/Tests/badge.svg
     :alt: GitHub Workflow Status
-    :target: https://github.com/timoludwig/sphinxcontrib-django2/actions?query=workflow%3ATests
-.. image:: https://img.shields.io/pypi/v/sphinxcontrib-django2.svg
+    :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-django2/
-.. image:: https://codecov.io/gh/timoludwig/sphinxcontrib-django2/branch/develop/graph/badge.svg
+    :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/timoludwig/sphinxcontrib-django2
+    :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/timoludwig/sphinxcontrib-django2
+.. image:: https://img.shields.io/github/license/edoburu/sphinxcontrib-django
     :alt: GitHub license
-    :target: https://github.com/timoludwig/sphinxcontrib-django2/blob/develop/LICENSE
-.. image:: https://readthedocs.org/projects/sphinxcontrib-django2/badge/?version=latest
+    :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-django2.readthedocs.io/en/latest/?badge=latest
+    :target: https://sphinxcontrib-django.readthedocs.io/en/latest/?badge=latest
 
 |
 
-.. image:: https://raw.githubusercontent.com/timoludwig/sphinxcontrib-django2/main/docs/images/django-sphinx-logo-blue.png
+.. 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-django2/
+    :target: https://pypi.org/project/sphinxcontrib-django/
 
-sphinxcontrib-django2
+sphinxcontrib-django
 =====================
 
 This is a sphinx extension which improves the documentation of Django apps.
@@ -46,10 +46,6 @@ Improvements for the output of Sphinx's autodoc for Django classes:
   ``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``) and Sphinx (``:event:``,
   ``:confval:``)
 
-This is a fork of `sphinxcontrib-django`_, which seems to be no longer maintained.
-
-.. _sphinxcontrib-django: https://github.com/edoburu/sphinxcontrib-django
-
 
 Installation
 ------------
@@ -58,7 +54,7 @@ Install the package via pip:
 
 .. code-block:: bash
 
-    pip install sphinxcontrib-django2
+    pip install sphinxcontrib-django
 
 
 Configuration
@@ -71,9 +67,9 @@ Add the following to your Sphinx config file ``conf.py``:
     # Add source directory to sys.path
     sys.path.insert(0, os.path.abspath("../src"))
 
-    # Add sphinxcontrib_django2 to installed extensions
+    # Add sphinxcontrib_django to installed extensions
     extensions = [
-        "sphinxcontrib_django2",
+        "sphinxcontrib_django",
     ]
 
     # Configure the path to the Django settings module
@@ -137,4 +133,4 @@ Build the documentation with:
     cd docs
     make html
 
-The documentation is automatically deployed to `Read the Docs <https://sphinxcontrib-django2.rtfd.io>`_.
+The documentation is automatically deployed to `Read the Docs <https://sphinxcontrib-django.rtfd.io>`_.

docs/conf.py

@@ -4,11 +4,11 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-from sphinxcontrib_django2 import __version__
+from sphinxcontrib_django import __version__
 
 # -- Project information -----------------------------------------------------
 
-project = "sphinxcontrib-django2"
+project = "sphinxcontrib-django"
 copyright = "2021"
 author = "Timo Ludwig"
 
@@ -25,7 +25,7 @@
     "sphinx.ext.autodoc",
     "sphinx_rtd_theme",
     "sphinx_last_updated_by_git",
-    "sphinxcontrib_django2.roles",
+    "sphinxcontrib_django.roles",
 ]
 
 # Warn about all references where the target cannot be found

docs/docstrings.rst

@@ -1,63 +1,63 @@
 Docstrings
 ==========
 
-.. automodule:: sphinxcontrib_django2.docstrings
+.. automodule:: sphinxcontrib_django.docstrings
    :members:
    :undoc-members:
    :show-inheritance:
 
 Field Utilities
 ---------------
 
-.. automodule:: sphinxcontrib_django2.docstrings.field_utils
+.. automodule:: sphinxcontrib_django.docstrings.field_utils
    :members:
    :undoc-members:
    :show-inheritance:
 
 Attributes
 ----------
 
-.. automodule:: sphinxcontrib_django2.docstrings.attributes
+.. automodule:: sphinxcontrib_django.docstrings.attributes
    :members:
    :undoc-members:
    :show-inheritance:
 
 Classes
 -------
 
-.. automodule:: sphinxcontrib_django2.docstrings.classes
+.. automodule:: sphinxcontrib_django.docstrings.classes
    :members:
    :undoc-members:
    :show-inheritance:
 
 Data
 ----
 
-.. automodule:: sphinxcontrib_django2.docstrings.data
+.. automodule:: sphinxcontrib_django.docstrings.data
    :members:
    :undoc-members:
    :show-inheritance:
 
 Methods
 -------
 
-.. automodule:: sphinxcontrib_django2.docstrings.methods
+.. automodule:: sphinxcontrib_django.docstrings.methods
    :members:
    :undoc-members:
    :show-inheritance:
 
 Patches
 -------
 
-.. automodule:: sphinxcontrib_django2.docstrings.patches
+.. automodule:: sphinxcontrib_django.docstrings.patches
    :members:
    :undoc-members:
    :show-inheritance:
 
 Config
 ------
 
-.. automodule:: sphinxcontrib_django2.docstrings.config
+.. automodule:: sphinxcontrib_django.docstrings.config
    :members:
    :undoc-members:
    :show-inheritance:

docs/index.rst

@@ -1,7 +1,7 @@
 Sphinx extension for Django apps
 ================================
 
-`sphinxcontrib-django2 <https://pypi.org/project/sphinxcontrib-django2/>`__ is a sphinx extension which improves the documentation of Django apps.
+`sphinxcontrib-django <https://pypi.org/project/sphinxcontrib-django/>`__ is a sphinx extension which improves the documentation of Django apps.
 
 .. toctree::
    :maxdepth: 4

docs/reference.rst

@@ -1,7 +1,7 @@
-sphinxcontrib_django2
+sphinxcontrib_django
 =====================
 
-.. automodule:: sphinxcontrib_django2
+.. automodule:: sphinxcontrib_django
    :members:
    :undoc-members:
    :show-inheritance:
@@ -17,7 +17,7 @@ sphinxcontrib_django2
 Roles
 -----
 
-.. automodule:: sphinxcontrib_django2.roles
+.. automodule:: sphinxcontrib_django.roles
    :members:
    :undoc-members:
    :show-inheritance:

pyproject.toml

@@ -3,7 +3,10 @@
     requires      = ["setuptools"]
 
 [project]
-    authors = [{ name = "Timo Ludwig", email = "[email protected]" }]
+    authors = [
+        { name = "Diederik van der Boor", email = "[email protected]" },
+        { name = "Timo Ludwig", email = "[email protected]" }
+    ]
     classifiers = [
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
@@ -31,15 +34,15 @@
     dynamic = ["version"]
     keywords = ["django", "docstrings", "extension", "sphinx"]
     license = { text = "Apache2 2.0 License" }
-    name = "sphinxcontrib-django2"
+    name = "sphinxcontrib-django"
     readme = "README.rst"
     requires-python = ">=3.7"
 
     [project.urls]
-        "Bug Tracker"   = "https://github.com/timoludwig/sphinxcontrib-django2/issues"
-        "Documentation" = "https://sphinxcontrib-django2.readthedocs.io/"
-        "Release Notes" = "https://github.com/timoludwig/sphinxcontrib-django2/blob/develop/CHANGES.rst"
-        "Source Code"   = "https://github.com/timoludwig/sphinxcontrib-django2"
+        "Bug Tracker"   = "https://github.com/edoburu/sphinxcontrib-django/issues"
+        "Documentation" = "https://sphinxcontrib-django.readthedocs.io/"
+        "Release Notes" = "https://github.com/edoburu/sphinxcontrib-django/blob/main/CHANGES.rst"
+        "Source Code"   = "https://github.com/edoburu/sphinxcontrib-django"
 
     [project.optional-dependencies]
         dev = ["pre-commit"]
@@ -52,17 +55,17 @@
         test = ["coverage", "pytest", "requests-mock"]
 
 [tool.setuptools.dynamic]
-    version = { attr = "sphinxcontrib_django2.__version__" }
+    version = { attr = "sphinxcontrib_django.__version__" }
 
 [tool.setuptools.packages.find]
-    include = ["sphinxcontrib_django2*"]
+    include = ["sphinxcontrib_django*"]
 
 [tool.black]
     skip-magic-trailing-comma = true
 
 [tool.coverage.run]
     command_line = "-m pytest"
-    source       = ["sphinxcontrib_django2"]
+    source       = ["sphinxcontrib_django"]
 
 [tool.pytest.ini_options]
     addopts    = "-ra -q"
@@ -80,7 +83,7 @@
     max-line-length = 99
 
 [tool.isort]
-    known_first_party = "sphinxcontrib_django2"
+    known_first_party = "sphinxcontrib_django"
     # Approach Black compatibility (just run black after isort)
     include_trailing_comma = true
     line_length            = 88

sphinxcontrib_django2/__init__.py renamed to sphinxcontrib_django/__init__.py

@@ -10,8 +10,8 @@ def setup(app):
     """
     Allow this module to be used as sphinx extension.
 
-    Setup the two sub-extensions :mod:`~sphinxcontrib_django2.docstrings` and
-    :mod:`~sphinxcontrib_django2.roles` which can also be imported separately.
+    Setup the two sub-extensions :mod:`~sphinxcontrib_django.docstrings` and
+    :mod:`~sphinxcontrib_django.roles` which can also be imported separately.
 
     :param app: The Sphinx application object
     :type app: ~sphinx.application.Sphinx

sphinxcontrib_django2/docstrings/__init__.py renamed to sphinxcontrib_django/docstrings/__init__.py

@@ -4,15 +4,15 @@
 For example:
 
 * List all model and form fields as parameters
-  (see:mod:`~sphinxcontrib_django2.docstrings.classes`)
+  (see:mod:`~sphinxcontrib_django.docstrings.classes`)
 * Improve field representations in the documentation
-  (see :mod:`~sphinxcontrib_django2.docstrings.attributes`)
+  (see :mod:`~sphinxcontrib_django.docstrings.attributes`)
 * Add information about autogenerated methods
-  (see :mod:`~sphinxcontrib_django2.docstrings.methods`)
+  (see :mod:`~sphinxcontrib_django.docstrings.methods`)
 * Improve the appearance of static iterable data
-  (see :mod:`~sphinxcontrib_django2.docstrings.data`)
+  (see :mod:`~sphinxcontrib_django.docstrings.data`)
 * Fix the intersphinx mappings to the Django documentation
-  (see :mod:`~sphinxcontrib_django2.docstrings.patches`)
+  (see :mod:`~sphinxcontrib_django.docstrings.patches`)
 """
 import importlib
 import os
@@ -32,14 +32,14 @@ def setup(app):
     """
     Allow this package to be used as Sphinx extension.
 
-    This is also called from the top-level :meth:`~sphinxcontrib_django2.setup`.
+    This is also called from the top-level :meth:`~sphinxcontrib_django.setup`.
 
     It connects to the sphinx events :event:`autodoc-skip-member` and
     :event:`autodoc-process-docstring`.
 
     Additionally, the sphinx config value ``django_settings`` is added via
     :meth:`~sphinx.application.Sphinx.add_config_value` and
-    :meth:`~sphinxcontrib_django2.docstrings.setup_django` is called on the
+    :meth:`~sphinxcontrib_django.docstrings.setup_django` is called on the
     :event:`config-inited` event.
 
     :param app: The Sphinx application object