Skip to content

Scheduled weekly dependency update for week 18 #137

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
May 1, 2023
Merged

Scheduled weekly dependency update for week 18 #137

merged 6 commits into from
May 1, 2023

Conversation

pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented May 1, 2023

Update Sphinx from 6.2.0 to 7.0.0.

Changelog

7.0.0

=====================================

Incompatible changes
--------------------

* 11359: Remove long-deprecated aliases for ``MecabSplitter`` and
``DefaultSplitter`` in ``sphinx.search.ja``.
* 11360: Remove deprecated ``make_old_id`` functions in domain object
description classes.
* 11363: Remove the Setuptools integration (``build_sphinx`` hook in
``setup.py``).
* 11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module.
* 11365: Remove support for the ``jsdump`` format in ``sphinx.search``.
* 11366: Make ``locale`` a required argument to
``sphinx.util.i18n.format_date()``.
* 11370: Remove deprecated ``sphinx.util.stemmer`` module.
* 11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function.
* 11372: Remove deprecated ``sphinx.io.read_doc()`` function.
* 11373: Removed deprecated ``sphinx.util.get_matching_files()`` function.
* 11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()``
function.
* 11379: Make the ``env`` argument to ``Builder`` subclasses required.
* 11380: autosummary: Always emit grouped import exceptions.
* 11381: Remove deprecated ``style`` key for HTML templates.
* 11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses``
attribute.
* 11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and
``sphinx.builders.html.HTMLTranslator`` attributes.
* 11385: Remove support for HTML 4 output.

6.2.1

=====================================

Bugs fixed
----------

* 11355: Revert the default type of :confval:`nitpick_ignore` and
:confval:`nitpick_ignore_regex` to ``list``.
Links

Update sphinx-autodoc-typehints from 1.23.4 to 1.23.4.

Changelog

1.22

- Allow Sphinx explicitly to write in parallel.
- Fixed crash when documenting ParamSpecArgs

1.21.7

- Fixed a bug where if a class has an attribute and a constructor argument with the same name, the constructor argument
type would be rendered incorrectly (issue 308)

- Fixed napoleon handling of numpy docstrings with no specified return type.

1.21.6

- Fix a `Field list ends without a blank line` warning (issue 305).

1.21.5

- More robust determination of rtype location / fix issue 302

1.21.4

- Improvements to the location of the return type

1.21.3

- Use format_annotation to render class attribute type annotations

1.21.2

- Fix overloads support

1.21.1

- Fix spacing between `:rtype:` and directives

1.21

- Handle types from types module
- If module is \_io, use io instead
- Put rtype before examples or usage section
- Remove redundant return type for attributes
- Handle collections.abc.Callable as well as typing.Callable
- Put Literal args in code blocks

1.20.2

- Fix Optional role to be data.

1.20.1

- Fixed default options not displaying for parameters without type hints.

1.20

- Use hatchling instead of setuptools
- Add support for typing.ParamSpec
- Allow star prefixes for parameter names in docstring

1.19.2

- Fix incorrect domain used for collections.abc.Callable.

1.19.1

- Fix bug for recursive type alias.

1.19.0

- Support for CPython 3.11, no longer adds `Optional` when the argument is default per
[recommendation from PEP-484](https://github.com/tox-dev/sphinx-autodoc-typehints/pull/247).

1.18.3

- Support and require `nptyping>=2.1.2`

1.18.2

- Support and require `nptyping>=2.1.1`

1.18.1

- Fix mocked module import not working when used as guarded import

1.18.0

- Support and require `nptyping>=2`
- Handle `UnionType`

1.17.1

- Mark it as requiring `nptyping<2`

1.17.0

- Add `typehints_use_rtype` option
- Handles `TypeError` when getting source code via inspect

1.16.0

- Add support for type subscriptions with multiple elements, where one or more elements are tuples; e.g.,
`nptyping.NDArray[(Any, ...), nptyping.Float]`
- Fix bug for arbitrary types accepting singleton subscriptions; e.g., `nptyping.Float[64]`
- Resolve forward references
- Expand and better handle `TypeVar`
- Add intershpinx reference link for `...` to `Ellipsis` (as is just an alias)

1.15.3

- Prevents reaching inner blocks that contains `if TYPE_CHECKING`

1.15.2

- Log a warning instead of crashing when a type guard import fails to resolve
- When resolving type guard imports if the target module does not have source code (such is the case for C-extension
modules) do nothing instead of crashing

1.15.1

- Fix `fully_qualified` should be `typehints_fully_qualified`

1.15.0

- Resolve type guard imports before evaluating annotations for objects
- Remove `set_type_checking_flag` flag as this is now done by default
- Fix crash when the `inspect` module returns an invalid python syntax source
- Made formatting function configurable using the option `typehints_formatter`

1.14.1

- Fixed `normalize_source_lines()` messing with the indentation of methods with decorators that have parameters starting
with `def`.
- Handle `ValueError` or `TypeError` being raised when signature of an object cannot be determined
- Fix `KeyError` being thrown when argument is not documented (e.g. `cls` argument for class methods, and `self` for
methods)

1.14.0

- Added `typehints_defaults` config option allowing to automatically annotate parameter defaults.

1.13.1

- Fixed `NewType` inserts a reference as first argument instead of a string

1.13.0

- Dropped Python 3.6 support
- Python 3.10 support
- Normalize async functions properly
- Allow py310 style annotations (PEP-563)

1.12.0

- Dropped Python 3.5 support
- Added the simplify_optional_unions config option (PR by tillhainbach)
- Fixed indentation of multiline strings (PR by Yuxin Wu)

1.11.1

- Changed formatting of `None` to point to the Python stdlib docs (PR by Dominic Davis-Foster)
- Updated special dataclass handling (PR by Lihu Ben-Ezri-Ravin)

1.11.0

- Dropped support for Sphinx \< 3.0
- Added support for alternative parameter names (`arg`, `argument`, `parameter`)
- Fixed import path for Signature (PR by Matthew Treinish)
- Fixed `TypeError` when formatting a parametrized `typing.IO` annotation
- Fixed data class displaying a return type in its `__init__()` method

1.10.3

- Fixed `TypeError` (or wrong rendered class name) when an annotation is a generic class that has a `name` property

1.10.2

- Fixed inner classes missing their parent class name(s) when rendered

1.10.1

- Fixed `KeyError` when encountering mocked annotations (`autodoc_mock_imports`)

1.10.0

- Rewrote the annotation formatting logic (fixes Python 3.5.2 compatibility regressions and an `AttributeError`
regression introduced in v1.9.0)
- Fixed decorator classes not being processed as classes

1.9.0

- Added support for [typing_extensions](https://pypi.org/project/typing-extensions/)
- Added the `typehints_document_rtype` option (PR by Simon-Martin Schröder)
- Fixed metaclasses as annotations causing `TypeError`
- Fixed rendering of `typing.Literal`
- Fixed OSError when generating docs for SQLAlchemy mapped classes
- Fixed unparametrized generic classes being rendered with their type parameters (e.g. `Dict[~KT, ~VT]`)

1.8.0

- Fixed regression which caused `TypeError` or `OSError` when trying to set annotations due to PR 87
- Fixed unintentional mangling of annotation type names
- Added proper `:py:data` targets for `NoReturn`, `ClassVar` and `Tuple`
- Added support for inline type comments (like `(int, str) -> None`) (PR by Bernát Gábor)
- Use the native AST parser for type comment support on Python 3.8+

1.7.0

- Dropped support for Python 3.4
- Fixed unwrapped local functions causing errors (PR by Kimiyuki Onaka)
- Fixed `AttributeError` when documenting the `__init__()` method of a data class
- Added support for type hint comments (PR by Markus Unterwaditzer)
- Added flag for rendering classes with their fully qualified names (PR by Holly Becker)

1.6.0

- Fixed `TypeError` when formatting annotations from a class that inherits from a concrete generic type (report and
tests by bpeake-illuscio)
- Added support for `typing_extensions.Protocol` (PR by Ian Good)
- Added support for `typing.NewType` (PR by George Leslie-Waksman)

1.5.2

- Emit a warning instead of crashing when an unresolvable forward reference is encountered in type annotations

1.5.1

- Fixed escape characters in parameter default values getting lost during signature processing
- Replaced use of the `config-inited` event (which inadvertently required Sphinx 1.8) with the `builder-inited` event

1.5.0

- The setting of the `typing.TYPECHECKING` flag is now configurable using the `set_type_checking_flag` option

1.4.0

- The extension now sets `typing.TYPECHECKING` to `True` during setup to include conditional imports which may be used
in type annotations
- Fixed parameters with trailing underscores (PR by Daniel Knell)
- Fixed KeyError with private methods (PR by Benito Palacios Sánchez)
- Fixed deprecation warning about the use of formatargspec (PR by Y. Somda)
- The minimum Sphinx version is now v1.7.0

1.3.1

- Fixed rendering of generic types outside the typing module (thanks to Tim Poterba for the PR)

1.3.0

- Fixed crash when processing docstrings from nested classes (thanks to dilyanpalauzov for the fix)
- Added support for Python 3.7
- Dropped support for Python 3.5.0 and 3.5.1

1.2.5

- Ensured that `:rtype:` doesn\'t get joined with a paragraph of text (thanks to Bruce Merry for the PR)

1.2.4

- Removed support for `backports.typing` as it has been removed from the PyPI
- Fixed first parameter being cut out from class methods and static methods (thanks to Josiah Wolf Oberholtzer for the
PR)

1.2.3

- Fixed `process_signature()` clobbering any explicitly overridden signatures from the docstring

1.2.2

- Explicitly prefix `:class:`, `:mod:` et al with `:py:`, in case `py` is not the default domain of the project (thanks
Monty Taylor)

1.2.1

- Fixed `` ValueError` when ``getargspec()\`\` encounters a built-in function
- Fixed `AttributeError` when `Any` is combined with another type in a `Union` (thanks Davis Kirkendall)

1.2.0

- Fixed compatibility with Python 3.6 and 3.5.3
- Fixed `NameError` when processing signatures of wrapped functions with type hints
- Fixed handling of slotted classes with no `__init__()` method
- Fixed Sphinx warning about parallel reads
- Fixed return type being added to class docstring from its `__init__()` method (thanks to Manuel Krebber for the patch)
- Fixed return type hints of `property` methods being omitted (thanks to pknight for the patch)
- Added a test suite (thanks Manuel Krebber)

1.1.0

- Added proper support for `typing.Tuple` (pull request by Manuel Krebber)

1.0.6

- Fixed wrong placement of `:rtype:` if a multi-line `:param:` or a `:returns:` is used

1.0.5

- Fixed coroutine functions\' signatures not being processed when using sphinxcontrib-asyncio

1.0.4

- Fixed compatibility with Sphinx 1.4

1.0.3

- Fixed \"self\" parameter not being removed from exception class constructor signatures
- Fixed process_signature() erroneously removing the first argument of a static method

1.0.2

- Fixed exception classes not being processed like normal classes

1.0.1

- Fixed errors caused by forward references not being looked up with the right globals

1.0.0

- Initial release
Links

Update furo from 2023.3.27 to 2023.3.27.

Changelog

2023.03.27

- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples

2023.03.23

- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.

2022.12.07

- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the `meta` generator tag with a comment.
- Tweak labels with icons to prevent users selecting icons as text on touch.

2022.09.29

- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.

2022.09.15

- Add a minimum version constraint on pygments.
- Add an explicit dependency on `sass`.
- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own `svg` in related pages `nav`.
- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.

2022.06.21

- Fix `docutils <= 0.17.x` compatibility.
- Bump to the latest Node.js LTS.

2022.06.04.1

- Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04

- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to `basic-ng` as the base theme (from {pypi}`sphinx-basic-ng`).
- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using `basic-ng`'s `edit-this-page` component.
- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.

2022.04.07

- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for `html_baseurl`.
- Improve "Edit this page" icon to be more accessible.
- Improve `html_sidebars` example.
- Tweak positioning of back to top on desktop.

2022.03.04

- Improve support for print media.
- Reduce heading sizes for h3 and below.
- Don't allow selecting headerlink content.
- Improve how overflow wrapping is handled.
- Add a reference from the configuration variables to the color customisation page.

2022.02.23

- ✨ Add a "Back to Top" button that shows up when scrolling up.
- Add a URL to GitHub in Project-URLs.
- Break long words in the prev/next buttons.
- Fix includes in Kitchen sink.
- Handle external references for viewcode links.
- Properly offset scrollspy.
- Switch from `optional-dependencies` (AKA extras) to dedicated `requirements.txt` files.

2022.02.14.1

- Drop a `, /` for positional-only arguments.

2022.02.14

- ✨ Rework typography, pivoting to bold headings.
- ✨ Redesign the footer and allow footer icons.
- ✨ Change the default permalinks icon.
- ✨ Add an edit button for RTD-built pages.
- ✨ Better integration of Read the Docs' embed.
- Add dedicated headings for each admonition type.
- Add the green border for `sphinx-copybutton` after copy.
- Bump to the latest Node.js LTS.
- Don't set `display: block` on visible `only-*` elements. (for sphinx-design)
- Improve footnote styling.
- Improve styling for `div.math` equation numbers.
- Rework how `:target` links are handled.
- Stylise `small` tag.
- Stylise code block captions.
- Stylise various forms of blockquotes.
- Treat all custom code injection as unstable.
- Tweak admonition spacing.
- Tweak how muted-links are presented.
- Use a better color for hovered tabs, with sphinx-inline-tabs.
- Use higher specificity for hiding elements. (for sphinx-design)
- Use the modern Firefox focus ring.

2022.01.02

- Improve colours for `sphinx-inline-tabs`.
- Improve highlighting of active definition list targets.
- Improve error message when `html_style` is set.
- Update workflow to reflect reality.
- Be more selective about API documentation headings.
- Increase specificity of `pre` selector for line-height.

2021.11.23

- Improve code block styling.
- Explicitly declare compatibility constraints for pygments.
- Break words in API documentation, when the words are too long.
- Drop the `def ` on function and method signatures.
- Reduce the font-weight in `sig-prename`.

2021.11.16

- Fix a typo, that broke the sidebar highlight logic.

2021.11.15

- Tweak API documentation presentation to match pdoc3's style.
- Bring back browser-specific prefixes, for compatibility.

2021.11.12.1

- Fix RECORD file contents.

2021.11.12

- Adopt `sphinx-theme-builder`, which runs the JS-based asset build process during the regular Python build process.
- Rework the build pipeline to be webpack-based.
- Tweak colours in dark mode.
- Present better error messages on misconfiguration.
- Tweak presentation of blockquotes, to be more visually distinct.
- Stylize topics like admonitions, as specified in the reStructuredText spec.
- Handle long single words in the sidebar.
- Only hide Sphinx from the footer, when `show_sphinx` is set to `False`.

2021.10.09

- Add a bit more space below content icon container.
- Add CSS variables for table header background and table border.
- Fix behaviour of URL-style references in `html_logo` and `html_favicon`.
- Improve selector for embedded-in-text images.
- Improve the contrast ratios in API documentation.

2021.09.22

- Restyle API documentation signatures, to have a background and use monospace fonts.
- Reduce spacing for items in API documentation.
- Improve the presentation of links in site-wide announcement.
- Only add a border on code inside paragraphs.
- Use `noscript` for presenting "search needs JS" message.

2021.09.08

- Prevent screen-reader-only content from showing up in Sphinx search results.
- Improve support for various footer configurations.

2021.08.31

- First stable release! 🎉
- Document stability policy.
- Tweak API styling selectors.
- Drop reference to no-longer-used `pygments_dark.css`.
- Eagerly set the light/dark mode theme, when loading a page.

2021.08.17.beta43

- Add support for sphinx-design.
- Document sidebar title customization.
- Don't show "Contents" on pages without h1 headings.
- Add border to inline code, to improve contrast.
- Reduce contrast on dark-mode text.

2021.08.11.beta42

- Fix esoteric failure due to inability to write pygments.css.
- Improve overscroll behaviour.

2021.07.31.beta41

- Adapt for newer sphinx-copybutton design
- Improved screen reader experience
- Bring back asset digests, to avoid caching-related issues

2021.07.28.beta40

- Add spacing around light theme / dark theme / auto theme toggle.

2021.07.28.beta39

- Site visitors can now force light theme / dark theme, independently of browser settings. 🎉
- Rework handling of dark theme code block highlighting.
- "Hide Search Matches" shows up in the sidebar, when the user has search matches highlighted.
- Search term highlights are only shown in the page content.
- Fix styling for default aligned tables.
- Enable smooth scrolling.
- meta: Upgrade NodeJS packages and start using Babel.
- meta: Rework organisation of various user-facing CSS variables.

2021.07.05.beta38

- Fix image alignment in Sphinx 4.

2021.06.24.beta37

- Require Sphinx 4.
- Rework CSS/JS asset inclusion, to work better with Sphinx 4.
- Document how to add a custom admonition style.

2021.06.18.beta36

- Fix dark mode highlighting in Sphinx 4.

2021.06.18.beta35

- Allow use with Sphinx 4.
- Fix right alignment of viewcode links, when used with certain API
signatures.

2021.04.11.beta34

- Account for even more variants of sidebar-caption HTML.

2021.04.11.beta33

- Another styling update sidebar-caption related changes in Sphinx.

2021.04.11.beta32

- Add a basic domainindex page, without dedicated styling.
- Add recommendation for sphinx-opengraph.
- Account for newer Sphinx versions changing classes for captions.
- Account for the broken docutils release.
- Right align viewcode links (like `[source]`) allowing wrapping of API
signatures gradefully.

2021.03.20.beta31

- Get `pygments_dark_style` working.
- Use the correct layout for domain index placeholder.

2021.03.20.beta30

- Fix a typo in the README.
- Add an escape hatch for specific table of contents.

2021.03.19.beta29

- Update Python-Requires to >=3.6.
- Account for nested admonitions.
- Center align items like other themes.
- Don't stylize the compound `kbd` tags.
- Fix a broken internal link in documentation.
- Fix a mistyped vertical-align style.
- Vertically align embedded-in-text images.
- Declare in HTML that the theme's pages support multiple color schemes.

2021.02.28.beta28

- Fix a bug in how stylesheets are handled.
- Clarify how to install directly from GitHub.
- Document how to install from git.

2021.02.28.beta27

- Center figures and legends with `margin: auto`.
- Improve compatibility with `json` builder, by not passing functions into the
Jinja templates.
- Add a friendly comment to `domainindex.html`, about it not being implemented.
- Add styling for GUI labels.

2021.02.27.beta26

- Fix wrong height on wide screens, for pages with a tall sidebar but not-tall
content.
- Add type annotations to the codebase! 🎉
- Fix an instance of missing brackets in documentation.

2021.02.21.beta25

- Document how to inject custom code in Sphinx documentation
- Document that `pygments_dark_style` is Furo-specific
- Make `sphinx-panels` respond to dark mode with Furo
- Stop `defer`ing Javascript, which was causing search to break in some cases.

2020.12.30.beta24

- Disable environment caching if `pygments_dark_style` is changed.
- Revert to earlier background color for inline literals, and allow configuring
it via a CSS variables.

2020.12.28.beta23

- Fix code-block overflow issue, introduced by the fix for sphinx-copybutton compatibility.
- Tweak horizontal rules, to always be 1px tall.
- Tweak background color for inline literals, to match code blocks.

2020.12.28.beta22

- MAJOR: Move theme files into a "furo" folder.
- This affects any users deriving from furo's templates.
- Add (custom) support for `pygments_dark_style`.
- Add support for `genindex` pages.
- Note that `html_split_index` is not supported at this time.
- Add support for highlighting API elements, when accessed via "hash" in URL.
- Add `language_data.js` to search page, fixing `Stemmer` related failures in Sphinx 3.4.
- Document how to add a site-wide announcement.
- Fix sphinx-copybutton placement on scrollable code blocks.
- Generate an error page, for documents using `layout.html` from Sphinx's `basic` theme.
- Translate placeholder in sidebar's search.
- Tweak how additional h1 headings are handled in ToC sidebar.
- Update dependency constraints, limiting compatibility to Sphinx 3.x versions.

2020.12.09.beta21

- Rebuild theme assets, for main release.

2020.12.09.beta20

- Clarify expectations around sidebar customisation.
- Declare plugin information to pacify Sphinx's "are you parallel" check.
- Disable sidebar-follows-you-as-you-scroll Javascript.
- Fix scrollbar styles affecting document body.
- Tweak colors for problematic content.
- Tweak how words wrap in sidebar title.
- Tweak spacing in API documentation.
- Tweak wrapping of text in API function/class signatures.

2020.11.27.beta19

- Add styling for rubrics.
- Add styling for scrollbars, to make them match the theme.
- Fix bottom-of-page JS conditional.
- Fix stability of resources hashes. (thanks [dvarrazzo](https://github.com/dvarrazzo))
- Fix styling for multi-term definition lists items.
- Re-add our development documentation kitchen-sink.
- Tweak how ToC sidebar handles scrollbars.
- Tweak styling for basic definition lists.

2020.11.19.beta18

- Fix search page. It had become non-operational, due to changes to JS
in the previous release.

2020.11.15.beta17

- Add properly documented mechanisms for customising the sidebar.
- Add dedicated styling for ethical ads.
- Tweak how JS scripts are loaded.

2020.11.14.beta16

- Add a separate file for CSS that affects other Sphinx extensions.
- Add content to all the existing pages in documentation.
- Clarify that Furo is biased toward smaller documentation sets.
- Clarify that logo files need to be in `html_static_path`
- Improve various explanations in documentation.
- Tweak borders inside tables.
- Tweak bottom spacing on right sidebar.
- Tweak CSS and JS blocks in `base.html` template.
- Tweak how captions for toctrees look.
- Tweak spacing on sidebar ad on Read the Docs.

2020.11.10.beta15

- Add a recommendations page, for plugins
- Add support for different logos in light and dark mode
- Change location of TOC drawer icon on mobile
- Drop support for `html_sidebars` based customisation.
- Improve how the RTD ads work
- Improve TOC sidebar auto-scroll functional
- Significantly improve footer capabilities

2020.11.01.beta14

- Add classifiers to the theme.
- Add friendly messages for users of `html_sidebars`.
- Add link to homepage, in mobile header.
- Add support for ethical ads in the sidebar.
- Change `css_variables` to `light_css_variables`.
- Change font stack to match to GitHub.
- Change the color used for `<hr>` tags.
- Change unsplash URLs to use cute+animal as cues
- Document `navigation_with_keys`.
- Drop logic that jumps toc-scroll to bottom-of-page.
- Improve customisation documentation.
- Remove text underline from headerlink.
- Strip tags in title.

2020.10.15.beta13

- Add a direct dependency on Sphinx.
- Add styling for "highlighted text" in dark mode.
- Add support for sphinx-inline-tabs.
- Change the default development branch name to `main`.
- Drop customisations for sphinx-panel's tabs.
- Rework the entire handling of background and foreground colours.
- Tweak API documentation, when presented in dark mode.
- Tweak Bootstrap 4 `.container` styling (comes from sphinx-panel).
- Tweak borders on tables.
- Tweak dark mode colors.
- Tweak light mode colors.

2020.10.13.beta12

- Fix image link in README, to show up correctly on PyPI.

2020.10.13.beta11

- Tweak colors for dark mode.
- Tweak presentation of `<kbd>`, to look better in dark mode.

2020.10.13.beta10

- Add dark mode support, based on `prefers-color-scheme`! 🎉
- Add more information in the documentation (reference and customisation).
- Add sourcemaps in the generated distribution.
- Add support for glossary lists.
- Drop the custom Read the Docs-specific CSS.
- Fix bad transparency handling for sidebar hover on Safari.
- Fix shrinking of sidebar brand image on Safari.
- Tweak spacing in admonitions.

2020.10.05.beta9

- Add per-build hashes to asset URLs, to simplify cache invalidation.
- Tweak spacing in API documentation.

2020.09.28.beta8

- Require Sphinx 3.
- Add styling for API documentation.
- Add styling for abbreviations.
- Add `clear` CSS property for left/right aligned content.
- Add styling to tweak the look of tabs.
- Drop the complexities introduced for custom homepages.
- Tweak color of problematic content.
- Tweak font-size handling for code-blocks.
- Tweak font-size handling for admonitions.
- Tweak spacing around code-blocks.
- Tweak how pages look with announcement and shorter-than-viewport content.
- Tweak styling for lists.
- Fix overlays to correctly show on top of content.
- Restructure sidebar scrolling, to correctly fill viewport.
- Change JS from the basic theme to use blocking network requests.
- Change inline table of contents to look like an error, nudging toward to not using it.

2020.09.15.beta7

- Automate version management
- Use correct width for elements on small screens (100% instead of 100vw)

2020.09.15.beta6

- Tweak header on small screens.
- Tweak spacing for small screens.
- Place "sidebar" directive's contents inline, on small screens.

2020.9.8.beta4

- More fixes for Python 3.7 support.

2020.9.8.beta3

- Add support for `sphinx.ext.todo`.
- Add support for hiding name in sidebar.
- Add reference to deployed documentation in README.
- Tweak font size for admonitions.
- Tweak spacing for contents sidebar.
- Tweak styling of inline code.
- Fix support for Python < 3.8.

2020.9.8.beta2

- Add support for logos in the sidebar.
- Fix path used for search page.
- Tweak height for short pages on mobile (100vh resulted in a scroll).
- Tweak definition lists.
- Tweak line height in contents, to accommodate for code literals.
- Use `em` as the unit for layout sizes.
- Start writing theme's documentation.
- Deploy documentation on <https://pradyunsg.me/furo/>.

2020.9.2.beta1

Initial release.

2020.08.14.beta5

{important}
This release was not correctly versioned and is not installed preferentially over beta4.


- Add CSS variables for header foreground and background.
- Add styling for captions.
- Add styling for correctly handling permalinks.
- Correctly stylize _only_ definition lists with the rules intended for them.
- Fix next/prev links flowing into one-another by limiting width to 50%.
- Fix positioning of collapsed contents sidebar icon.
- Fix shrinking arrows in next/prev links.
- Include `basic` theme's JS files unconditionally. This should help with compatibility with various Sphinx extensions and Read the Docs.
- Make `math` elements scrollable, when wider than the page.
- Tweak images to be responsive.
- Tweak spacing of paragraphs.
- Tweak location of Read the Docs' injected version helper.
Links

Update sphinxext-opengraph from 0.8.2 to 0.8.2.

Changelog

0.8.2

What's Changed
* Fix DeprecationWarning: The 'warn' method is deprecated, use 'warning' instead by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/99
* FIX: Social media twitter card tags by choldgraf in https://github.com/wpilibsuite/sphinxext-opengraph/pull/101


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.8.1...v0.8.2

0.8.1

What's Changed
* Add exception for SVG images by choldgraf in https://github.com/wpilibsuite/sphinxext-opengraph/pull/97


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/V0.8.0...v0.8.1

0.8.0

What's Changed
* Format with Black 23.1.0 by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/95
* ENH: Add social card previews by choldgraf in https://github.com/wpilibsuite/sphinxext-opengraph/pull/88

New Contributors
* choldgraf made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/88

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.5...V0.8.0

0.7.5

What's Changed
* check for description length before subscripting by TheTripleV in https://github.com/wpilibsuite/sphinxext-opengraph/pull/90


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.4...v0.7.5

0.7.4

What's Changed
* Use Sphinx Builder method to get page url by attakei in https://github.com/wpilibsuite/sphinxext-opengraph/pull/89

New Contributors
* attakei made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/89

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.3...v0.7.4

0.7.3

What's Changed
* Fix field names in readme by shiftinv in https://github.com/wpilibsuite/sphinxext-opengraph/pull/85
* Allow dirhtml builder without `ogp_site_url` by rkdarst in https://github.com/wpilibsuite/sphinxext-opengraph/pull/84
* Take default og:site_name from sphinx `project` config value by rkdarst in https://github.com/wpilibsuite/sphinxext-opengraph/pull/83

New Contributors
* shiftinv made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/85
* rkdarst made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/84

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.2...v0.7.3

0.7.2

What's Changed
* Also publish sdist to PyPI by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/82


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.1...v0.7.2

0.7.1

What's Changed
* Do not append `index` with `dirhtml` by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/78
* Create wheel with version number not "main" by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/79
* Don't run CI on tag and push by TheTripleV in https://github.com/wpilibsuite/sphinxext-opengraph/pull/80


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.7.0...v0.7.1

0.7.0

What's Changed
* Fix option name in README.md. by ezio-melotti in https://github.com/wpilibsuite/sphinxext-opengraph/pull/68
* Add option to use og:description as description by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/71
* Revert "Add option to use og:description as description" by TheTripleV in https://github.com/wpilibsuite/sphinxext-opengraph/pull/73
* Test multiple Sphinx and OS versions by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/70
* Fix ci workflow syntax by TheTripleV in https://github.com/wpilibsuite/sphinxext-opengraph/pull/74
* Tidy up whitespace by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/69
* ci: Pin PyPI publish action to v1 by auscompgeek in https://github.com/wpilibsuite/sphinxext-opengraph/pull/75
* Add support for meta description by hugovk in https://github.com/wpilibsuite/sphinxext-opengraph/pull/72

New Contributors
* ezio-melotti made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/68
* hugovk made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/71
* auscompgeek made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/75

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.3...v0.7.0

0.6.3

What's Changed
* Fix first_image not resolving correctly when in subdirectories and ogp_image is defined. by ItayZiv in https://github.com/wpilibsuite/sphinxext-opengraph/pull/63


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.2...v0.6.3

0.6.2

What's Changed
* chore(README) Typo fix by tony in https://github.com/wpilibsuite/sphinxext-opengraph/pull/58
* Fix first_image not resolving correctly in subdirectories by ItayZiv in https://github.com/wpilibsuite/sphinxext-opengraph/pull/61

New Contributors
* tony made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/58

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.1...v0.6.2

0.6.1

What's Changed
* fix og:url for "dirhtml" builder by ru-fu in https://github.com/wpilibsuite/sphinxext-opengraph/pull/54

New Contributors
* ru-fu made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/54

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.0...v0.6.1

0.6.0

What's Changed
* Include license in setup.py by sciencewhiz in https://github.com/wpilibsuite/sphinxext-opengraph/pull/52
* Add per-file overrides using field lists by ItayZiv in https://github.com/wpilibsuite/sphinxext-opengraph/pull/50

New Contributors
* sciencewhiz made their first contribution in https://github.com/wpilibsuite/sphinxext-opengraph/pull/52

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.5.1...v0.6.0

0.5.1

What's Changed
* Escape quotations in Open Graph description when smart quotes are disabled. by ItayZiv in https://github.com/wpilibsuite/sphinxext-opengraph/pull/49


**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.5.0...v0.5.1

0.5.0

What's Changed
* Skipping code blocks and fixing docs build. by Robpol86 in https://github.com/wpilibsuite/sphinxext-opengraph/pull/47
* Convert relative paths to absolute in og:image. by Robpol86 in https://github.com/wpilibsuite/sphinxext-opengraph/pull/48

**Full Changelog**: https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.4.2...v0.5.0

0.4.1

Fixed a major issue preventing the extension working on normal Sphinx installs

0.4.0

- Implement RTD Support (30)
- Fix bug with ogp_image_alt default (29) 
- Use first image (after refactor) (26)
- Refactor codebase (24)

Full list is available [here](https://github.com/wpilibsuite/sphinxext-opengraph/commits/master)

0.3.1

- Exclude raw nodes from description (23)
- Add black formatter (17)
- EOL  EOF (16) 
- Add support for og:image:alt (15)

0.3.0

- Code refactors
- Add support for custom tags

ogp_custom_meta_tags = [
 '<meta property="og:ignore_canonical" content="true" />',
]

0.2.0

- Numerous refactors
- Fix bug if description length was less than 3
- Use the first header in the page as title
- Skip admonitions and invisible content for page description
Links

Update sphinx-copybutton from 0.5.2 to 0.5.2.

Changelog

0.5.2

([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.0...TODO))


- BUG: Don't exclude `.gp` class by default.  This made excluding prompts more automatic, but broke the existing pattern-based prompt exclusion.  [188](https://github.com/executablebooks/sphinx-copybutton/pull/188) ([rkdarst](https://github.com/rkdarst))
- MAINT: Add Sphinx Extension classifier (189)  [189](https://github.com/executablebooks/sphinx-copybutton/pull/189) ([jdillard](https://github.com/jdillard ))
- DOCS: Improve docs related to text exclusion [187](https://github.com/executablebooks/sphinx-copybutton/pull/187) ([rkdarst](https://github.com/rkdarst))

0.5.1

([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.5.0...e529aa0c7c0bf6ad880904f7a8876f33040e5c09))

- ENH: Unselectable text is now also not highlighted when you manually highlight a code cell. Exclude unselectable text from being copied (update) [178](https://github.com/executablebooks/sphinx-copybutton/pull/178) ([rkdarst](https://github.com/rkdarst))
- ENH: After copying, the copybutton will disappear _before_ the icon changes back if you are no longer hovering on the code cell. FIX: Make copybutton remain for a second during success [176](https://github.com/executablebooks/sphinx-copybutton/pull/176) ([choldgraf](https://github.com/choldgraf))
- MAINT: Add support for Python 3.10 [174](https://github.com/executablebooks/sphinx-copybutton/pull/174) ([hugovk](https://github.com/hugovk))

0.5.0

([full changelog](https://github.com/executablebooks/sphinx-copybutton/compare/v0.4.0...915aa4cf0b06f7b781bc4edfc204c62f2ce7cdb6))

This release updates the copy button design and behavior to match GitHub's design guide and button behavior. It also directly inserts the SVG instead of linking it via an `<img>` tag so that it can be styled more flexibly.

Enhancements

- ENH: Directly add SVG instead of linking via IMG [161](https://github.com/executablebooks/sphinx-copybutton/pull/161) ([choldgraf](https://github.com/choldgraf))
- ENH: Update copybutton image to match GitHub [155](https://github.com/executablebooks/sphinx-copybutton/pull/155) ([choldgraf](https://github.com/choldgraf))

0.4.0

Enhancements ✨
* The Copy Button UI/UX is now inspired from the recent GitHub copy button updates. [133](https://github.com/executablebooks/sphinx-copybutton/pull/133)

0.3.2

Enhancements ✨
* Add line continuation matching and "HERE-documents" [126](https://github.com/executablebooks/sphinx-copybutton/pull/126) ([sappelhoff](https://github.com/sappelhoff))
* Allow copying empty lines [127](https://github.com/executablebooks/sphinx-copybutton/pull/127) ([amotl](https://github.com/amotl))
* ✨ IMPROVE: add a check-mark SVG icon and improve the look of the button

Translations 🌎
* Add Russian translations [120](https://github.com/executablebooks/sphinx-copybutton/pull/120) ([Nikulinnn](https://github.com/Nikulinnn))
* Add Simplified Chinese translations [116](https://github.com/executablebooks/sphinx-copybutton/pull/116) ([seisman](https://github.com/seisman))
* French translations added [114](https://github.com/executablebooks/sphinx-copybutton/pull/114) ([dbitouze](https://github.com/dbitouze))

0.3.1

- 👌 Improved copy icon (thanks to (pradyunsg)[https://github.com/pradyunsg])
- 📚 Improved examples of regex settings (thanks to [s-weigand](https://github.com/s-weigand) and [edmcdonagh](https://github.com/edmcdonagh))

[Full commit list](https://github.com/executablebooks/sphinx-copybutton/compare/v0.3.0...852a9468f1d9e7e12e2c6c90394e8029d571bc14)

0.3.0

Breaking

- Copy raw regex string to JS template, thanks to s-weigand.
This fixes the way that the `copybutton_prompt_text` value is injected into `copybutton.js_t` (as discussed in 86).
The raw string formatting means that backslashes are now propagated correctly and removes the need for "double escaping".
Users will need to update their `copybutton_prompt_text` string accordingly.

Changed

- Upgraded [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19
Links

Update typing-extensions from 4.5.0 to 4.5.0.

The bot wasn't able to find a changelog for this release. Got an idea?

Links

@JarryShaw JarryShaw merged commit c4bceeb into main May 1, 2023
@JarryShaw JarryShaw deleted the pyup-scheduled-update-2023-05-01 branch May 1, 2023 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JarryShaw JarryShaw JarryShaw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pyup-bot @JarryShaw