Changelog
*Sourced from [sphinx's changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES).*
> Release 2.3.0 (released Dec 15, 2019)
> =====================================
>
> Incompatible changes
> --------------------
>
> * [#6742](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6742): ``end-before`` option of :rst:dir:`literalinclude` directive does not
> match the first line of the code block.
> * [#1331](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/1331): Change default User-Agent header to ``"Sphinx/X.Y.Z requests/X.Y.Z
> python/X.Y.Z"``. It can be changed via :confval:`user_agent`.
> * [#6867](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6867): text: content of admonitions starts after a blank line
>
> Deprecated
> ----------
>
> * ``sphinx.builders.gettext.POHEADER``
> * ``sphinx.io.SphinxStandaloneReader.app``
> * ``sphinx.io.SphinxStandaloneReader.env``
> * ``sphinx.util.texescape.tex_escape_map``
> * ``sphinx.util.texescape.tex_hl_escape_map_new``
> * ``sphinx.writers.latex.LaTeXTranslator.no_contractions``
>
> Features added
> --------------
>
> * [#6707](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6707): C++, support bit-fields.
> * [#267](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/267): html: Eliminate prompt characters of doctest block from copyable text
> * [#6548](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6548): html: Use favicon for OpenSearch if available
> * [#6729](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6729): html theme: agogo theme now supports ``rightsidebar`` option
> * [#6780](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6780): Add PEP-561 Support
> * [#6762](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6762): latex: Allow to load additonal LaTeX packages via ``extrapackages`` key
> of :confval:`latex_elements`
> * [#1331](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/1331): Add new config variable: :confval:`user_agent`
> * [#6000](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6000): LaTeX: have backslash also be an inline literal word wrap break
> character
> * [#4186](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/4186): LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental)
> * [#6812](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6812): Improve a warning message when extensions are not parallel safe
> * [#6818](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6818): Improve Intersphinx performance for multiple remote inventories.
> * [#2546](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/2546): apidoc: .so file support
> * [#6798](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6798): autosummary: emit ``autodoc-skip-member`` event on generating stub file
> * [#6483](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6483): i18n: make explicit titles in toctree translatable
> * [#6816](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6816): linkcheck: Add :confval:`linkcheck_auth` option to provide
> authentication information when doing ``linkcheck`` builds
> * [#6872](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6872): linkcheck: Handles HTTP 308 Permanent Redirect
> * [#6613](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6613): html: Wrap section number in span tag
> * [#6781](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6781): gettext: Add :confval:`gettext_last_translator' and
> :confval:`gettext_language_team` to customize headers of POT file
>
> Bugs fixed
> ----------
> ... (truncated)
Commits
- [`86143a5`](https://github.com/sphinx-doc/sphinx/commit/86143a54b86049dc8d725ee1418e9523c41a7b77) Bump to 2.3.0 final
- [`0760136`](https://github.com/sphinx-doc/sphinx/commit/076013602bc21ebdc68352751464135540f946f8) Merge pull request [#6891](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6891) from jfbu/latex_6890_curlyquote
- [`e49e98a`](https://github.com/sphinx-doc/sphinx/commit/e49e98a9faee76a9c298d508353513c9ec5073d4) Update CHANGES for PR [#6891](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6891)
- [`d6f1351`](https://github.com/sphinx-doc/sphinx/commit/d6f135152836dc36149c95df2e5b7df92dcd4831) Merge pull request [#6908](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6908) from tk0miya/6900_sphinx-build-D_accepts_boolean
- [`dc8cf9e`](https://github.com/sphinx-doc/sphinx/commit/dc8cf9eba3cd99b4ab1ee7ef90ea5f8a040d7cdb) Merge pull request [#6919](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6919) from tk0miya/6781_custom_POT_headers
- [`30b26dd`](https://github.com/sphinx-doc/sphinx/commit/30b26dd6a12de641776d871f9291de556de093fd) LaTeX: avoid quotes and TeX ligature replacements in PDF output
- [`ebdd210`](https://github.com/sphinx-doc/sphinx/commit/ebdd210a6b2d7884f8f1254ce73bceb121761818) Fix [#6900](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6900): sphinx-build: -D option does not considers 0 and 1 as a boolean value
- [`3e10cdb`](https://github.com/sphinx-doc/sphinx/commit/3e10cdb3d983749dd449281eea98fe22c9014b85) Close [#6781](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6781): gettext Add confvals to customize headers of POT file
- [`2ec6ce8`](https://github.com/sphinx-doc/sphinx/commit/2ec6ce85ef781795dcfb63ccef736b33c6ac96a2) Merge pull request [#6924](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6924) from tk0miya/pinning_coverage
- [`42f6b91`](https://github.com/sphinx-doc/sphinx/commit/42f6b913332220128e696efcf16fb3fe7c6efc9f) CI: Pinning coverage < 5.0
- Additional commits viewable in [compare view](https://github.com/sphinx-doc/sphinx/compare/v2.2.2...v2.3.0)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
If all status checks pass Dependabot will automatically merge this pull request.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme
Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Pull request limits (per update run and/or open at any time)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Bumps sphinx from 2.2.2 to 2.3.0.
Changelog
*Sourced from [sphinx's changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES).* > Release 2.3.0 (released Dec 15, 2019) > ===================================== > > Incompatible changes > -------------------- > > * [#6742](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6742): ``end-before`` option of :rst:dir:`literalinclude` directive does not > match the first line of the code block. > * [#1331](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/1331): Change default User-Agent header to ``"Sphinx/X.Y.Z requests/X.Y.Z > python/X.Y.Z"``. It can be changed via :confval:`user_agent`. > * [#6867](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6867): text: content of admonitions starts after a blank line > > Deprecated > ---------- > > * ``sphinx.builders.gettext.POHEADER`` > * ``sphinx.io.SphinxStandaloneReader.app`` > * ``sphinx.io.SphinxStandaloneReader.env`` > * ``sphinx.util.texescape.tex_escape_map`` > * ``sphinx.util.texescape.tex_hl_escape_map_new`` > * ``sphinx.writers.latex.LaTeXTranslator.no_contractions`` > > Features added > -------------- > > * [#6707](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6707): C++, support bit-fields. > * [#267](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/267): html: Eliminate prompt characters of doctest block from copyable text > * [#6548](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6548): html: Use favicon for OpenSearch if available > * [#6729](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6729): html theme: agogo theme now supports ``rightsidebar`` option > * [#6780](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6780): Add PEP-561 Support > * [#6762](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6762): latex: Allow to load additonal LaTeX packages via ``extrapackages`` key > of :confval:`latex_elements` > * [#1331](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/1331): Add new config variable: :confval:`user_agent` > * [#6000](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6000): LaTeX: have backslash also be an inline literal word wrap break > character > * [#4186](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/4186): LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental) > * [#6812](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6812): Improve a warning message when extensions are not parallel safe > * [#6818](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6818): Improve Intersphinx performance for multiple remote inventories. > * [#2546](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/2546): apidoc: .so file support > * [#6798](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6798): autosummary: emit ``autodoc-skip-member`` event on generating stub file > * [#6483](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6483): i18n: make explicit titles in toctree translatable > * [#6816](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6816): linkcheck: Add :confval:`linkcheck_auth` option to provide > authentication information when doing ``linkcheck`` builds > * [#6872](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6872): linkcheck: Handles HTTP 308 Permanent Redirect > * [#6613](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6613): html: Wrap section number in span tag > * [#6781](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6781): gettext: Add :confval:`gettext_last_translator' and > :confval:`gettext_language_team` to customize headers of POT file > > Bugs fixed > ---------- > ... (truncated)Commits
- [`86143a5`](https://github.com/sphinx-doc/sphinx/commit/86143a54b86049dc8d725ee1418e9523c41a7b77) Bump to 2.3.0 final - [`0760136`](https://github.com/sphinx-doc/sphinx/commit/076013602bc21ebdc68352751464135540f946f8) Merge pull request [#6891](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6891) from jfbu/latex_6890_curlyquote - [`e49e98a`](https://github.com/sphinx-doc/sphinx/commit/e49e98a9faee76a9c298d508353513c9ec5073d4) Update CHANGES for PR [#6891](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6891) - [`d6f1351`](https://github.com/sphinx-doc/sphinx/commit/d6f135152836dc36149c95df2e5b7df92dcd4831) Merge pull request [#6908](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6908) from tk0miya/6900_sphinx-build-D_accepts_boolean - [`dc8cf9e`](https://github.com/sphinx-doc/sphinx/commit/dc8cf9eba3cd99b4ab1ee7ef90ea5f8a040d7cdb) Merge pull request [#6919](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6919) from tk0miya/6781_custom_POT_headers - [`30b26dd`](https://github.com/sphinx-doc/sphinx/commit/30b26dd6a12de641776d871f9291de556de093fd) LaTeX: avoid quotes and TeX ligature replacements in PDF output - [`ebdd210`](https://github.com/sphinx-doc/sphinx/commit/ebdd210a6b2d7884f8f1254ce73bceb121761818) Fix [#6900](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6900): sphinx-build: -D option does not considers 0 and 1 as a boolean value - [`3e10cdb`](https://github.com/sphinx-doc/sphinx/commit/3e10cdb3d983749dd449281eea98fe22c9014b85) Close [#6781](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6781): gettext Add confvals to customize headers of POT file - [`2ec6ce8`](https://github.com/sphinx-doc/sphinx/commit/2ec6ce85ef781795dcfb63ccef736b33c6ac96a2) Merge pull request [#6924](https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/6924) from tk0miya/pinning_coverage - [`42f6b91`](https://github.com/sphinx-doc/sphinx/commit/42f6b913332220128e696efcf16fb3fe7c6efc9f) CI: Pinning coverage < 5.0 - Additional commits viewable in [compare view](https://github.com/sphinx-doc/sphinx/compare/v2.2.2...v2.3.0)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.If all status checks pass Dependabot will automatically merge this pull request.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Automerge options (never/patch/minor, and dev/runtime dependencies) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired)