Use sphinx.ext.extlinks for :issue: links.

This commit is contained in:
Joshua Bronson 2022-12-25 08:07:12 -05:00
parent ae9f10bc7b
commit 05582a619a
3 changed files with 24 additions and 16 deletions

View File

@ -321,7 +321,7 @@ Remove APIs deprecated in the previous release:
Fixes a bug introduced in 0.15.0 Fixes a bug introduced in 0.15.0
that caused any class with an ``inverse`` attribute that caused any class with an ``inverse`` attribute
to be incorrectly considered a subclass of :class:`collections.abc.Mapping`. to be incorrectly considered a subclass of :class:`collections.abc.Mapping`.
`#111 <https://github.com/jab/bidict/issues/111>`__ :issue:`111`
0.19.0 (2020-01-09) 0.19.0 (2020-01-09)
@ -440,7 +440,7 @@ Remove APIs deprecated in the previous release:
:func:`deepcopied <copy.deepcopy>` and :func:`deepcopied <copy.deepcopy>` and
:func:`unpickled <pickle.loads>` :func:`unpickled <pickle.loads>`
bidicts to have their inverses set incorrectly. bidicts to have their inverses set incorrectly.
`#94 <https://github.com/jab/bidict/issues/94>`__ :issue:`94`
0.18.0 (2019-02-14) 0.18.0 (2019-02-14)
@ -448,7 +448,7 @@ Remove APIs deprecated in the previous release:
- Rename ``bidict.BidirectionalMapping.inv`` to :attr:`~bidict.BidirectionalMapping.inverse` - Rename ``bidict.BidirectionalMapping.inv`` to :attr:`~bidict.BidirectionalMapping.inverse`
and make :attr:`bidict.BidictBase.inv` an alias for :attr:`~bidict.BidictBase.inverse`. and make :attr:`bidict.BidictBase.inv` an alias for :attr:`~bidict.BidictBase.inverse`.
`#86 <https://github.com/jab/bidict/issues/86>`__ :issue:`86`
- :meth:`bidict.BidirectionalMapping.__subclasshook__` now requires an ``inverse`` attribute - :meth:`bidict.BidirectionalMapping.__subclasshook__` now requires an ``inverse`` attribute
rather than an ``inv`` attribute for a class to qualify as a virtual subclass. rather than an ``inv`` attribute for a class to qualify as a virtual subclass.
@ -632,7 +632,7 @@ The following breaking changes are expected to affect few if any users.
See the new See the new
:ref:`addendum:\`\`bidict\`\` Avoids Reference Cycles` :ref:`addendum:\`\`bidict\`\` Avoids Reference Cycles`
documentation. documentation.
`#24 <https://github.com/jab/bidict/issues/20>`__ :issue:`24`
- Make :func:`bidict.BidictBase.__eq__` significantly - Make :func:`bidict.BidictBase.__eq__` significantly
more speed- and memory-efficient when comparing to more speed- and memory-efficient when comparing to
@ -763,7 +763,7 @@ The following breaking changes are expected to affect few if any users.
- Fix a bug introduced in 0.14.0 for Python 2 users - Fix a bug introduced in 0.14.0 for Python 2 users
where attempting to call ``viewitems()`` where attempting to call ``viewitems()``
would cause a ``TypeError``. would cause a ``TypeError``.
`#48 <https://github.com/jab/bidict/issues/48>`__ :issue:`48`
0.14.0 (2017-11-20) 0.14.0 (2017-11-20)
@ -1062,7 +1062,7 @@ This release includes multiple API simplifications and improvements.
for use with the :mod:`copy` module. for use with the :mod:`copy` module.
- Fix issue preventing a client class from inheriting from ``loosebidict``. - Fix issue preventing a client class from inheriting from ``loosebidict``.
`#34 <https://github.com/jab/bidict/issues/34>`__ :issue:`34`
- Add benchmarking to tests. - Add benchmarking to tests.
@ -1138,7 +1138,7 @@ This release includes multiple API simplifications and improvements.
- In the interest of protecting data safety more proactively, by default - In the interest of protecting data safety more proactively, by default
bidict now raises an error on attempting to insert a non-unique value, bidict now raises an error on attempting to insert a non-unique value,
rather than allowing its associated key to be silently overwritten. rather than allowing its associated key to be silently overwritten.
See discussion in `#21 <https://github.com/jab/bidict/issues/21>`__. See discussion in :issue:`21`.
- New :meth:`~bidict.bidict.forceupdate` method - New :meth:`~bidict.bidict.forceupdate` method
provides a bulk :meth:`~bidict.bidict.forceput` operation. provides a bulk :meth:`~bidict.bidict.forceput` operation.
@ -1152,30 +1152,30 @@ This release includes multiple API simplifications and improvements.
- Remove ``bidict.__invert__``, and with it, support for the ``~b`` syntax. - Remove ``bidict.__invert__``, and with it, support for the ``~b`` syntax.
Use :attr:`~bidict.BidictBase.inv` instead. Use :attr:`~bidict.BidictBase.inv` instead.
`#19 <https://github.com/jab/bidict/issues/19>`__ :issue:`19`
- Remove support for the slice syntax. - Remove support for the slice syntax.
Use ``b.inv[val]`` rather than ``b[:val]``. Use ``b.inv[val]`` rather than ``b[:val]``.
`#19 <https://github.com/jab/bidict/issues/19>`__ :issue:`19`
- Remove ``bidict.invert``. - Remove ``bidict.invert``.
Use :attr:`~bidict.BidictBase.inv` Use :attr:`~bidict.BidictBase.inv`
rather than inverting a bidict in place. rather than inverting a bidict in place.
`#20 <https://github.com/jab/bidict/issues/20>`__ :issue:`20`
- Raise ``ValueExistsException`` - Raise ``ValueExistsException``
when attempting to insert a mapping with a non-unique key. when attempting to insert a mapping with a non-unique key.
`#21 <https://github.com/jab/bidict/issues/21>`__ :issue:`21`
- Rename ``collapsingbidict````loosebidict`` - Rename ``collapsingbidict````loosebidict``
now that it suppresses now that it suppresses
``ValueExistsException`` ``ValueExistsException``
rather than the less general ``CollapseException``. rather than the less general ``CollapseException``.
`#21 <https://github.com/jab/bidict/issues/21>`__ :issue:`21`
- ``CollapseException`` has been subsumed by - ``CollapseException`` has been subsumed by
``ValueExistsException``. ``ValueExistsException``.
`#21 <https://github.com/jab/bidict/issues/21>`__ :issue:`21`
- :meth:`~bidict.bidict.put` now raises ``KeyExistsException`` - :meth:`~bidict.bidict.put` now raises ``KeyExistsException``
when attempting to insert an already-existing when attempting to insert an already-existing

View File

@ -42,11 +42,12 @@ import bidict
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel', 'sphinx.ext.autosectionlabel',
'sphinx.ext.coverage', # 'sphinx.ext.coverage',
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.todo', # 'sphinx.ext.todo',
] ]
try: try:
import sphinx_copybutton # noqa: F401 import sphinx_copybutton # noqa: F401
@ -221,6 +222,13 @@ html_show_copyright = True
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'bidictdoc' htmlhelp_basename = 'bidictdoc'
# https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
extlinks = {
'issue': ('https://github.com/jab/bidict/issues/%s', '#%s')
}
# Ignore urls matching these regex strings when doing "make linkcheck" # Ignore urls matching these regex strings when doing "make linkcheck"
linkcheck_ignore = [ linkcheck_ignore = [
r'https://codecov\.io/.*', # gives 405 for HEAD requests r'https://codecov\.io/.*', # gives 405 for HEAD requests

View File

@ -122,7 +122,7 @@ for getting and setting keys by value:
See `this code <https://github.com/jab/bidict/blob/356dbe3/bidict/_bidict.py#L25>`__ See `this code <https://github.com/jab/bidict/blob/356dbe3/bidict/_bidict.py#L25>`__
for how this was implemented, for how this was implemented,
and `#19 <https://github.com/jab/bidict/issues/19>`__ for why this was dropped. and :issue:`19` for why this was dropped.
Property-based testing is indispensable Property-based testing is indispensable