Skip to content

Commit d0a25f0

Browse files
timobrembecktimobrembeck
committed
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/
1 parent 27e3dff commit d0a25f0

File tree

21 files changed

+67
-66
lines changed

21 files changed

+67
-66
lines changed

‎AUTHORS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ Original authors:
22

33
* Diederik van der Boor (@vdboor)
44

5-
Maintainer of this fork:
5+
Maintainer since 2020:
66

77
* Timo Ludwig (@timoludwig)

‎CHANGES.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Changelog
44
Version 1.6 (2022-11-24)
55
------------------------
66

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

98100

99101
Version 0.6 (2020-11-16)
100-
--------------------------
102+
------------------------
101103

102104
* Fix deferred attribute for Django >=2.1, <3.0
103105
* Django: Drop support for [1.11, 2.0], add support for [2.2, 3.0, 3.1]

‎README.rst‎

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
.. image:: https://github.com/timoludwig/sphinxcontrib-django2/workflows/Tests/badge.svg
1+
.. image:: https://github.com/edoburu/sphinxcontrib-django/workflows/Tests/badge.svg
22
:alt: GitHub Workflow Status
3-
:target: https://github.com/timoludwig/sphinxcontrib-django2/actions?query=workflow%3ATests
4-
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-django2.svg
3+
:target: https://github.com/edoburu/sphinxcontrib-django/actions?query=workflow%3ATests
4+
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-django.svg
55
:alt: PyPi
6-
:target: https://pypi.org/project/sphinxcontrib-django2/
7-
.. image:: https://codecov.io/gh/timoludwig/sphinxcontrib-django2/branch/develop/graph/badge.svg
6+
:target: https://pypi.org/project/sphinxcontrib-django/
7+
.. image:: https://codecov.io/gh/edoburu/sphinxcontrib-django/branch/main/graph/badge.svg
88
:alt: Code coverage
9-
:target: https://codecov.io/gh/timoludwig/sphinxcontrib-django2
9+
:target: https://codecov.io/gh/edoburu/sphinxcontrib-django
1010
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1111
:alt: Black Code Style
1212
:target: https://github.com/psf/black
13-
.. image:: https://img.shields.io/github/license/timoludwig/sphinxcontrib-django2
13+
.. image:: https://img.shields.io/github/license/edoburu/sphinxcontrib-django
1414
:alt: GitHub license
15-
:target: https://github.com/timoludwig/sphinxcontrib-django2/blob/develop/LICENSE
16-
.. image:: https://readthedocs.org/projects/sphinxcontrib-django2/badge/?version=latest
15+
:target: https://github.com/edoburu/sphinxcontrib-django/blob/main/LICENSE
16+
.. image:: https://readthedocs.org/projects/sphinxcontrib-django/badge/?version=latest
1717
:alt: Documentation Status
18-
:target: https://sphinxcontrib-django2.readthedocs.io/en/latest/?badge=latest
18+
:target: https://sphinxcontrib-django.readthedocs.io/en/latest/?badge=latest
1919

2020
|
2121
22-
.. image:: https://raw.githubusercontent.com/timoludwig/sphinxcontrib-django2/main/docs/images/django-sphinx-logo-blue.png
22+
.. image:: https://raw.githubusercontent.com/edoburu/sphinxcontrib-django/main/docs/images/django-sphinx-logo-blue.png
2323
:width: 500
2424
:alt: logo
25-
:target: https://pypi.org/project/sphinxcontrib-django2/
25+
:target: https://pypi.org/project/sphinxcontrib-django/
2626

27-
sphinxcontrib-django2
27+
sphinxcontrib-django
2828
=====================
2929

3030
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:
4646
``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``) and Sphinx (``:event:``,
4747
``:confval:``)
4848

49-
This is a fork of `sphinxcontrib-django`_, which seems to be no longer maintained.
50-
51-
.. _sphinxcontrib-django: https://github.com/edoburu/sphinxcontrib-django
52-
5349

5450
Installation
5551
------------
@@ -58,7 +54,7 @@ Install the package via pip:
5854

5955
.. code-block:: bash
6056
61-
pip install sphinxcontrib-django2
57+
pip install sphinxcontrib-django
6258
6359
6460
Configuration
@@ -71,9 +67,9 @@ Add the following to your Sphinx config file ``conf.py``:
7167
# Add source directory to sys.path
7268
sys.path.insert(0, os.path.abspath("../src"))
7369
74-
# Add sphinxcontrib_django2 to installed extensions
70+
# Add sphinxcontrib_django to installed extensions
7571
extensions = [
76-
"sphinxcontrib_django2",
72+
"sphinxcontrib_django",
7773
]
7874
7975
# Configure the path to the Django settings module
@@ -137,4 +133,4 @@ Build the documentation with:
137133
cd docs
138134
make html
139135
140-
The documentation is automatically deployed to `Read the Docs <https://sphinxcontrib-django2.rtfd.io>`_.
136+
The documentation is automatically deployed to `Read the Docs <https://sphinxcontrib-django.rtfd.io>`_.

‎docs/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
# list see the documentation:
55
# https://www.sphinx-doc.org/en/master/usage/configuration.html
66

7-
from sphinxcontrib_django2 import __version__
7+
from sphinxcontrib_django import __version__
88

99
# -- Project information -----------------------------------------------------
1010

11-
project = "sphinxcontrib-django2"
11+
project = "sphinxcontrib-django"
1212
copyright = "2021"
1313
author = "Timo Ludwig"
1414

@@ -25,7 +25,7 @@
2525
"sphinx.ext.autodoc",
2626
"sphinx_rtd_theme",
2727
"sphinx_last_updated_by_git",
28-
"sphinxcontrib_django2.roles",
28+
"sphinxcontrib_django.roles",
2929
]
3030

3131
# Warn about all references where the target cannot be found

‎docs/docstrings.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,63 @@
11
Docstrings
22
==========
33

4-
.. automodule:: sphinxcontrib_django2.docstrings
4+
.. automodule:: sphinxcontrib_django.docstrings
55
:members:
66
:undoc-members:
77
:show-inheritance:
88

99
Field Utilities
1010
---------------
1111

12-
.. automodule:: sphinxcontrib_django2.docstrings.field_utils
12+
.. automodule:: sphinxcontrib_django.docstrings.field_utils
1313
:members:
1414
:undoc-members:
1515
:show-inheritance:
1616

1717
Attributes
1818
----------
1919

20-
.. automodule:: sphinxcontrib_django2.docstrings.attributes
20+
.. automodule:: sphinxcontrib_django.docstrings.attributes
2121
:members:
2222
:undoc-members:
2323
:show-inheritance:
2424

2525
Classes
2626
-------
2727

28-
.. automodule:: sphinxcontrib_django2.docstrings.classes
28+
.. automodule:: sphinxcontrib_django.docstrings.classes
2929
:members:
3030
:undoc-members:
3131
:show-inheritance:
3232

3333
Data
3434
----
3535

36-
.. automodule:: sphinxcontrib_django2.docstrings.data
36+
.. automodule:: sphinxcontrib_django.docstrings.data
3737
:members:
3838
:undoc-members:
3939
:show-inheritance:
4040

4141
Methods
4242
-------
4343

44-
.. automodule:: sphinxcontrib_django2.docstrings.methods
44+
.. automodule:: sphinxcontrib_django.docstrings.methods
4545
:members:
4646
:undoc-members:
4747
:show-inheritance:
4848

4949
Patches
5050
-------
5151

52-
.. automodule:: sphinxcontrib_django2.docstrings.patches
52+
.. automodule:: sphinxcontrib_django.docstrings.patches
5353
:members:
5454
:undoc-members:
5555
:show-inheritance:
5656

5757
Config
5858
------
5959

60-
.. automodule:: sphinxcontrib_django2.docstrings.config
60+
.. automodule:: sphinxcontrib_django.docstrings.config
6161
:members:
6262
:undoc-members:
6363
:show-inheritance:

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Sphinx extension for Django apps
22
================================
33

4-
`sphinxcontrib-django2 <https://pypi.org/project/sphinxcontrib-django2/>`__ is a sphinx extension which improves the documentation of Django apps.
4+
`sphinxcontrib-django <https://pypi.org/project/sphinxcontrib-django/>`__ is a sphinx extension which improves the documentation of Django apps.
55

66
.. toctree::
77
:maxdepth: 4

‎docs/reference.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
sphinxcontrib_django2
1+
sphinxcontrib_django
22
=====================
33

4-
.. automodule:: sphinxcontrib_django2
4+
.. automodule:: sphinxcontrib_django
55
:members:
66
:undoc-members:
77
:show-inheritance:
@@ -17,7 +17,7 @@ sphinxcontrib_django2
1717
Roles
1818
-----
1919

20-
.. automodule:: sphinxcontrib_django2.roles
20+
.. automodule:: sphinxcontrib_django.roles
2121
:members:
2222
:undoc-members:
2323
:show-inheritance:

‎pyproject.toml‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
requires = ["setuptools"]
44

55
[project]
6-
authors = [{ name = "Timo Ludwig", email = "ti.ludwig@web.de" }]
6+
authors = [
7+
{ name = "Diederik van der Boor", email = "opensource@edoburu.nl" },
8+
{ name = "Timo Ludwig", email = "ti.ludwig@web.de" }
9+
]
710
classifiers = [
811
"Development Status :: 5 - Production/Stable",
912
"Environment :: Web Environment",
@@ -31,15 +34,15 @@
3134
dynamic = ["version"]
3235
keywords = ["django", "docstrings", "extension", "sphinx"]
3336
license = { text = "Apache2 2.0 License" }
34-
name = "sphinxcontrib-django2"
37+
name = "sphinxcontrib-django"
3538
readme = "README.rst"
3639
requires-python = ">=3.7"
3740

3841
[project.urls]
39-
"Bug Tracker" = "https://github.com/timoludwig/sphinxcontrib-django2/issues"
40-
"Documentation" = "https://sphinxcontrib-django2.readthedocs.io/"
41-
"Release Notes" = "https://github.com/timoludwig/sphinxcontrib-django2/blob/develop/CHANGES.rst"
42-
"Source Code" = "https://github.com/timoludwig/sphinxcontrib-django2"
42+
"Bug Tracker" = "https://github.com/edoburu/sphinxcontrib-django/issues"
43+
"Documentation" = "https://sphinxcontrib-django.readthedocs.io/"
44+
"Release Notes" = "https://github.com/edoburu/sphinxcontrib-django/blob/main/CHANGES.rst"
45+
"Source Code" = "https://github.com/edoburu/sphinxcontrib-django"
4346

4447
[project.optional-dependencies]
4548
dev = ["pre-commit"]
@@ -52,17 +55,17 @@
5255
test = ["coverage", "pytest", "requests-mock"]
5356

5457
[tool.setuptools.dynamic]
55-
version = { attr = "sphinxcontrib_django2.__version__" }
58+
version = { attr = "sphinxcontrib_django.__version__" }
5659

5760
[tool.setuptools.packages.find]
58-
include = ["sphinxcontrib_django2*"]
61+
include = ["sphinxcontrib_django*"]
5962

6063
[tool.black]
6164
skip-magic-trailing-comma = true
6265

6366
[tool.coverage.run]
6467
command_line = "-m pytest"
65-
source = ["sphinxcontrib_django2"]
68+
source = ["sphinxcontrib_django"]
6669

6770
[tool.pytest.ini_options]
6871
addopts = "-ra -q"
@@ -80,7 +83,7 @@
8083
max-line-length = 99
8184

8285
[tool.isort]
83-
known_first_party = "sphinxcontrib_django2"
86+
known_first_party = "sphinxcontrib_django"
8487
# Approach Black compatibility (just run black after isort)
8588
include_trailing_comma = true
8689
line_length = 88

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ def setup(app):
1010
"""
1111
Allow this module to be used as sphinx extension.
1212
13-
Setup the two sub-extensions :mod:`~sphinxcontrib_django2.docstrings` and
14-
:mod:`~sphinxcontrib_django2.roles` which can also be imported separately.
13+
Setup the two sub-extensions :mod:`~sphinxcontrib_django.docstrings` and
14+
:mod:`~sphinxcontrib_django.roles` which can also be imported separately.
1515
1616
:param app: The Sphinx application object
1717
:type app: ~sphinx.application.Sphinx

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
For example:
55
66
* List all model and form fields as parameters
7-
(see:mod:`~sphinxcontrib_django2.docstrings.classes`)
7+
(see:mod:`~sphinxcontrib_django.docstrings.classes`)
88
* Improve field representations in the documentation
9-
(see :mod:`~sphinxcontrib_django2.docstrings.attributes`)
9+
(see :mod:`~sphinxcontrib_django.docstrings.attributes`)
1010
* Add information about autogenerated methods
11-
(see :mod:`~sphinxcontrib_django2.docstrings.methods`)
11+
(see :mod:`~sphinxcontrib_django.docstrings.methods`)
1212
* Improve the appearance of static iterable data
13-
(see :mod:`~sphinxcontrib_django2.docstrings.data`)
13+
(see :mod:`~sphinxcontrib_django.docstrings.data`)
1414
* Fix the intersphinx mappings to the Django documentation
15-
(see :mod:`~sphinxcontrib_django2.docstrings.patches`)
15+
(see :mod:`~sphinxcontrib_django.docstrings.patches`)
1616
"""
1717
import importlib
1818
import os
@@ -32,14 +32,14 @@ def setup(app):
3232
"""
3333
Allow this package to be used as Sphinx extension.
3434
35-
This is also called from the top-level :meth:`~sphinxcontrib_django2.setup`.
35+
This is also called from the top-level :meth:`~sphinxcontrib_django.setup`.
3636
3737
It connects to the sphinx events :event:`autodoc-skip-member` and
3838
:event:`autodoc-process-docstring`.
3939
4040
Additionally, the sphinx config value ``django_settings`` is added via
4141
:meth:`~sphinx.application.Sphinx.add_config_value` and
42-
:meth:`~sphinxcontrib_django2.docstrings.setup_django` is called on the
42+
:meth:`~sphinxcontrib_django.docstrings.setup_django` is called on the
4343
:event:`config-inited` event.
4444
4545
:param app: The Sphinx application object

0 commit comments

Comments
 (0)