Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinxcontrib-bibtex to 2.6.2 #271

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pyup-bot
Copy link
Collaborator

This PR updates sphinxcontrib-bibtex from 2.2.0 to 2.6.2.

Changelog

2.6.2

----------------------

2.6.1

----------------------

* The ``:cite:alp:`` role in the super style now also suppresses the sup tag
in addition to the brackets, to make it easier to apply the necessary formatting
around the citation.

2.6.0

----------------------

* Pre- and post-text in citations are now supported for the
author_year, label, and super referencing styles. The syntax is
``:cite:p:`{pre-text}key{post-text} (requested by RobertoBagnara,
see issue 288 and pull request 316).
Refer to the documentation for more details.

* New alternative style citations are now supported for the
author_year, label, and super parenthetical referencing styles,
which are identical to parenthetical citations but without the brackets.
The syntax is
``:cite:alp:`key (requested by davidorme, see pull request 316).
Refer to the documentation for more details.

* Exclude docutils 0.18 and 0.19 to fix generation of a spurious div tag in the
html builder (see issues 330, 329, 323, 322, 309).

* Add test for running the extension on Cython modules (see issue 308).

* Add test for running the extension with autoapi (see issue 319).

* Sphinx versions 2.x (and lower) are no longer supported.
New minimum required version of Sphinx is 3.5.

* Running pytest without arguments will now by default skip all marked tests
that require additional dependencies (currently numpydoc, rinohtype, and
cython).

* Fix encoding issues when running tests on Windows.

* Python 3.6 is EOL and is therefore no longer officially supported.

2.5.0

----------------------

* Add support for the rinohtype builder (reported by brechtm, see issue 275).

* Migrate from ``pkg_resources`` to ``importlib.metadata``. A side effect of
this migration is that
**plugins registered at runtime are longer exposed as entry points**.
This is because ``importlib`` does not allow runtime modification of
entry points.

* Remove sphinxcontrib namespace ``__init__.py`` file (no longer needed for
Python 3.3+ by PEP420).

* Add support for docutils 0.18.

* Suppress LaTeX url commands in tooltips (see issue 305, reported by
1kastner).

* Document Markdown syntax for MyST (suggested by jacopok, see issue 310).

2.4.2

---------------------

* Add support for Python 3.10 and 3.11.

* New ``bibtex_tooltips`` option.
Set to ``False`` to disable tooltip generation.
See issue 286.

* New ``bibtex_tooltips_style`` option to customize tooltip text style.
If empty (the default), the bibliography style is used.
See issue 286.

* Support for ``root_doc`` option introduced in Sphinx 4.0
(see issue 292, reported by jhmeinke).

* Use container node instead of paragraph node for containing bibliographies,
fixing a violation against the docutils spec
(see issue 273, reported by rappdw, with additional input from brechtm).

* Fix mutable dataclass fields for Python 3.11 (see issue 284 and pull
request 285; reported and fixed by jamesjer)

* Internal refactor: embed ``reference_text_class`` directly inside the pybtex
nodes. This enables different text classes to be used by different styles, so
different sorts of docutils nodes can be generated on rendering depending on
the pybtex node used. See discussion in issue 275.

* Add numpydoc regression test.

* Bump minimal pybtex requirement to 0.24.

2.4.1

-------------------------

* Gracefully handle textual citations when author or year are missing
(see issue 267, reported by fbkarsdorp).

2.4.0

------------------------

* Allow specific warnings to be suppressed (see issue 255, contributed by
stevenrhall).

* Fix parsing of LaTeX url commands in bibtex fields (see issue 258, reported
by Matthew Giassa).

* Remove space between footnote and author for textual footnote citations in
the default foot referencing style.

* Document how to use a backslash escaped space to suppress space before
footnotes (see issue 256, reported by hagenw).

* Parse all bib files together, so macros specified in one file can be used in
another file (see issue 216, reported by mforbes).
As a consequence, duplicate citation keys across bib files will
now also result in proper warnings.
The ``parse_bibfile`` and ``process_bibfile`` functions have been been
replaced by ``parse_bibdata`` and ``process_bibdata`` in the API.

* New ``bibtex_cite_id``, ``bibtex_footcite_id``,
``bibtex_bibliography_id``, and ``bibtex_footbibliography_id`` settings,
which allow custom ids (which can be used as html anchors)
to be generated for citations and bibliographies,
based on the citation keys rather than some random numbers
(see issue 264, reported by kmuehlbauer).
Refer to the documentation for detailed usage and examples.

* Switch to github actions for regression testing.

* The API is now fully type checked.

* Various minor improvements in documentation and code.

2.3.0

-------------------

* Add ``:footcite:p:`` and ``:footcite:t:`` roles.
For capitalizing the first letter and/or listing the full author list,
you can use ``:footcite:ct:``, ``:footcite:ts:``, ``:footcite:cts:``,
and ``:footcite:ps:``.

* To configure your footnote referencing style,
an optional config setting ``bibtex_foot_reference_style`` has been added.
If not specified, this defaults to the ``foot`` style,
which will use plain footnote references for citation references, matching
the referencing style as in previous versions.
Footnote reference styles can be fully customized to your heart's desire,
similar to regular citation reference styles.

* New ``:cite:empty:`` role which registers a citation without generating
a reference, similar to LaTeX's nocite command (see issue 131).

* Citation keys can now be listed directly under the bibliography directive,
one key per line; such citations will always be included, regardless of
any filter settings (see issue 54).

* A plain text preview of the full citation information will be shown when
hovering over a citation reference
(see issue 198, requested by eric-wieser).

* The separator between the text and the reference of all textual citation
styles can now be customized.

2.2.1

-------------------

* The LaTeX output now uses hyperlink instead of sphinxcite. This fixes
issues with double brackets and other mismatches between LaTeX and
HTML outputs (see issue 244 reported by zhi-wang).

* The setup function now also returns the version of the extension (see
issue 239 reported by lcnittl).
Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants