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

Don't run bumpversion on package-lock.json #1321

Merged

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Aug 19, 2022

Fixes #1117 and #1310

@benjaoming benjaoming requested a review from a team as a code owner August 19, 2022 15:45
@benjaoming benjaoming force-pushed the no-bumpversion-package-lock.json branch from 0acb2e3 to 5087916 Compare August 19, 2022 15:46
@benjaoming benjaoming changed the title No bumpversion package lock.json Don't run bumpversion on package-lock.json Aug 19, 2022
Copy link
Collaborator

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could come back to the documentation updates once you've gone through the release process.

docs/contributing.rst Outdated Show resolved Hide resolved
#. Run ``python setup.py build_assets`` to rebuild all the theme assets and the Python
package.
#. Run ``npm run build`` to rebuild all the theme assets and the Python
package, notice that ``package-lock.json`` will be updated with a new package
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

package-lock.json is updated on npm install, not npm run build. npm install might run if you've never run npm run build before though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. Shouldn't we just add npm run install then?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it is better to exclude anything that touches package-lock.json from the build process.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the existing commands using python setup.py build_assets do all of this for us. It doesn't seem like we have any strong reason to change this, really.

Perhaps it is better to exclude anything that touches package-lock.json from the build process.

From the release process that is? It's best to have the lock file represent the build artifacts probably, I think it's helpful to have included in the release. It's not likely to be of much use to anyone, but will be used in CI to verify the release (as dependencies will install via npm ci in CI).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a Catch 22... what I mean is that if package-lock.json isn't touched during the release process, we shouldn't make updates to it.If we need to run commands that changes it, we should also be aware.

docs/contributing.rst Outdated Show resolved Hide resolved
@benjaoming benjaoming force-pushed the no-bumpversion-package-lock.json branch from 2e8c65a to 8e737d4 Compare August 19, 2022 20:46
Copy link
Collaborator

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good!

@benjaoming benjaoming merged commit d343a1d into readthedocs:master Aug 19, 2022
@benjaoming benjaoming deleted the no-bumpversion-package-lock.json branch August 19, 2022 22:49
benjaoming added a commit to benjaoming/sphinx_rtd_theme that referenced this pull request Aug 24, 2022
benjaoming added a commit that referenced this pull request Aug 27, 2022
* Fixup a wrong merge conflict resolution from #1321

* Add python_requires again to setup.cfg
khancyr pushed a commit to khancyr/sphinx_rtd_theme that referenced this pull request Oct 31, 2023
It seems readthedocs#677 never actually got merged into master

Apply suggestions from code review

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>

Add development version back to docs

Update to next development release after 1.0.0

For now, we'll be a bugfix release at 1.0.1 but do anticipate we'll be
adding features this release and will get to 1.1.0.

Requires readthedocs#1230

Use consistent indentation in src/sass/_theme_rst.sass (readthedocs#1234)

Fix typos (readthedocs#1291)

Fix CircleCI config

Build with Node 14 installed through orbs.

Fixes readthedocs#1275

Fix SASS syntax errors from readthedocs#967

This introduced syntax errors that were not picked up in review, the
`:not()` psuedo selector can't lead a selector in SASS.

Pin Jinja to pre-3.1 release

Ignore asdf configuration

Bump to a valid version scheme, bump node-sass for Node 14 support

Docker configuration for dev environment

Remove some text @agjohnson

First updates migrating to docker-compose

Removes Makefile + double FROM in Dockerfile

Fix node.js error in docker runtime, speed up build by not copying the entire context

Use static setuptools metadata

Add rule to remove double margin inside dl's

Remove double margin from all dl's not just last

Remove double margin from all dl's not just last

Add a demo with Python types (regression test for readthedocs#1196), rebuild theme.js

Bump to a valid version scheme, bump node-sass for Node 14 support

Do not bump the version in auto-maintained file package-lock.json

Adds wheel and a command to package bdist_wheel + sdist

Build everything one step at a time

Make note about releasing `package-lock.json`

Do not build the python package in this step

Fixes the fix from readthedocs#1315 - the CSS selector was wrong

Rebuild theme.css with "Fix <kbd> CSS selector readthedocs#1320"

Wrapping up the Docker work, using docker cp again in order to copy assets out of containers

Tune kbd selectors

Exclude option lists from selectors for kbd styling.

Revert change to JS package

This matches the version number in the Python package, and allows
bumpversion to continue working. We can revisit changing this version
later, but currently this version will never be updated again, as
bumpversion will not match this string anymore.

Fixes readthedocs#1326

Fix a wrong example, replace non-existing `Body Elements` with `References`

Add an upper bound for when Sphinx 6 is released

Fix readthedocs#1078: Citation not styled properly (readthedocs#1080)

* Fix readthedocs#1078: Citation not styled properly

Turns out our demo docs werent being rendered by sphinx as citations so this may have slipped though the sphinx 2 fixes.

I updated the demo docs and included the need style fixes.

* Group citations and footnotes

* Build Assets

* Build theme.css with "Fix readthedocs#1078: Citation not styled properly readthedocs#1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Fixes readthedocs#289: Inconsistent table typography sizing (readthedocs#1215)

* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for readthedocs#1215

* Add an example rendering with paragraphs inside tables

* build theme.css for readthedocs#1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Build matrix fixes (readthedocs#1338)

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

Add Python 3.10 support (readthedocs#1334)

* Add Python 3.10 support

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

* Set sphinx versions for Python 3.10

Fix definition lists inside api docs (readthedocs#1084)

* Fix definition lists inside api docs

This is similar to readthedocs#1080 (and is needed to fix citations in the demo here)

Fixes readthedocs#1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for readthedocs#1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Remove font-smoothing (readthedocs#1094)

* Remove font-smoothing

This is a non standard css feature and is not supported on many platforms. And has been removed from the css standard specification.
It is advized to not use it according to MDN along with many other guides on the internet.

* rebuild theme.css and badge_only.css for readthedocs#1094

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

CSS: Add overflow-wrap to links inside paragraphs (readthedocs#1193)

* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for readthedocs#1193

* build theme.css for readthedocs#1193

* Build theme.css for readthedocs#1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Update Breadcrumb Styles (readthedocs#1073)

* Update Breadcrumb Styles

- Fixes extra padding to the left/right
- Used slash instead of >>
- Make literalls match other link style
- Adds demo docs for testing

* Update comment

* Update src/sass/_theme_breadcrumbs.sass

Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

* Build theme.css for readthedocs#1073

* Build theme.css for readthedocs#1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

Fixup a wrong merge conflict resolution from readthedocs#1321 (readthedocs#1335)

* Fixup a wrong merge conflict resolution from readthedocs#1321

* Add python_requires again to setup.cfg

Add sphinx 5.2 to test matrix (readthedocs#1348)

Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)

* Update layout.html to support a sphinx version that is not three-integers. Useful for sphinx==5.2.0.post0

* Apply suggestions from code review

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* No reason to only have the first three elements from the sphinx version

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>

Translation updates: Pull translations from transifex, push new sources (readthedocs#1354)

Adds changelog for 1.1.0alpha1 (readthedocs#1353)

* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Additions to Tox and Circle CI matrix (readthedocs#1349)

* Refines tox matrix, adds a new target "sphinxdev" that can test the latest upstream development branch

* Adds missing tox environments in circle ci config

* Remove odd undefined py2 and py3 tox environments

Move context logic for layout.html to jinja (readthedocs#1356)

* Revert "Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)"

This reverts commit 45cf218.

* Always slice list before unpacking so number of elements is expected range

`map` filter returns a generator that needs to run through the `list` filter before slicing

* Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values

Release 1.1.0b1 + 1.1.0b2 (bump versions with bump2version) (readthedocs#1352)

* Bump to 1.1.0 using bump2version

* Use PEP440 and make it a beta, i.e. "1.1.0b1"

* Auto-generated package-lock.json but with version bumps

* Bump to 1.1.0b2, rebuild assets

Remove Jinja2 dependency (readthedocs#1360)

* Remove Jinja2 dependency, inherited from Sphinx + handled in external environments

* Remove mentioning of Jinja2 dependency change

* Add Jinja2<3.1 dependecy to affected tox environments

Release 1.1.0b3 (readthedocs#1361)

* Update __init__.py because it wasn't updated by previous bump2version

* Add some comments about docker mechanisms that are disturbing release workflow

* Bump to version 1.1.0b3

* Revert "Bump to 1.1.0b2, rebuild assets"

This reverts commit 615eb52.

* Add changelog entry for readthedocs#1073

* Changelog entry for readthedocs#1193

Bump to version 1.1.0 (readthedocs#1367)

Do not overflow object cross references (readthedocs#1369)

* Do not overflow object cross references

* Rebuild theme for readthedocs#1369

* Adds a demo for the regression

* Mock sphinx-automodapi for now, but we can use it soon

* we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood

* We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0.

* Add comment about the terrible tox workaround

* Use a less hacky way of conditional autosummary in demo API docs

- Use `only` directive for conditional reST instead
- Drops 1.6 from our text matrix, it was deprecated in 1.0 release.
  There were issues with the conditional directive only on 1.6 for some
  reason.

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Bugfix release 1.1.1 (readthedocs#1371)

* Bugfix release 1.1.1

* Release package updates

* Package lock
* Translations

Bump development version after 1.1.1 release (readthedocs#1372)

Update versioning docs to be explicit about our versioning workflow (readthedocs#1373)

Docs: Add upgrade instructions and simplify conf.py (readthedocs#1365)

* Docs: Clean up several broken cross-references

* Adds a section about upgrading the theme and add navigation structure to installation guide

* Add a reference from Changelog to "How to upgrade"

* Also don't import sphinx_rtd_theme in the theme's own docs/conf.py

* Remove trailing linebreaks

* Update docs/installing.rst

Co-authored-by: Anthony <aj@ohess.org>

* Apply suggestions from code review

Co-authored-by: Anthony <aj@ohess.org>

* Update docs/installing.rst

* Replace guidance with reference to Reproducible Builds

* Build link into sentence

* Update the tip about using build logs and the need to pin the theme for older projects

* Remove tip box for Read the Docs users re: @agjohnson's request

Co-authored-by: Anthony <aj@ohess.org>

New release of sphinxcontrib-httpdomain==1.8.1 broke tests (readthedocs#1383)

* New release of sphinxcontrib-httpdomain==1.8.1 broke tests

* Remove sphinxcontrib-httpdomain

Eager upgrade of all dependencies in docker development environment (readthedocs#1350)

* Do an eager upgrade of all dependencies in docker development environment

* Adds a comment about installation of deps and upgrade strategy

Added aria-label to search box input field. (readthedocs#1380)

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Added hidden text for home link in the breadcrumbs. (readthedocs#1384)

* Added hidden text for home link in breadcrumbs.

* Update breadcrumbs.html

* Update breadcrumbs.html

Add docutils 0.18 citation/footnote support using CSS grid (readthedocs#1381)

* Add docutils 0.18 citation/footnote support using CSS grid

This is a fix for readthedocs#1322 that continues our pattern for HTML5 support
using CSS grids, introduced for support for docutils < 0.17 HTML5
support.

* Add lots of backreferences to a footnote

* Drop brackets from footnote/citation links

The brackets seem to be another docutils addition.

* Tune grid display for Sphinx 4 and 5

Backrefs have a new styling that drops a lot of punctuation

* Bump dependency on docutils to < 0.19

* Small tweak to footnote backrefs row span

We don't want to use too large a value here, as some browsers might make
explicit rows for us. We can't target -1 because the row count is
implicit.

* Revert some new styling and use nonbreaking backrefs for now

* Downgrade tox

* Use before pseudo class to break up backrefs consistently

Add changelog entry for docutils 0.18 support (readthedocs#1389)

* Add changelog entry for docutils 0.18 support

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc1 (readthedocs#1391)

* Bump to 1.2.0alpha1

* bump 2 1.2.0rc1

* Update package-lock.json from nmp audit

* Sync translations from Transifex (no changes found though)

Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery (readthedocs#1385)

* Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery

* Adds Sphinx 6.0b2 to Tox test matrix

* Adds Sphinx 6 to relevant Circle CI pipelines

* Build docs with Sphinx 6.0b2

* Use stable Sphinx 6.0.0

support Python 3.11 with Sphinx 5.3+ (readthedocs#1395)

* support Python 3.11 with Sphinx 5.3+

* Update tox.ini

Co-authored-by: Michael R. Crusoe <1330696+mr-c@users.noreply.github.com>

Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>
Co-authored-by: Benjamin Balder Bach <benjaoming@gmail.com>

sphinx-rtd-theme will automatically enable sphinxcontrib-jquery (readthedocs#1399)

1.2.0rc2 (readthedocs#1397)

* Bump to 1.2.0rc2, add changelog entry on Sphinx 6

* Pull translations (no changes)

* loosen sphinx 6 pinning

Updates to package-lock.json for 1.2.0rc2 (readthedocs#1400)

Updates to package-lock.json

Sphinx 6: Use logo_url instead of logo (readthedocs#1405)

* Sphinx 6: Use logo_url instead of logo

* Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0

* Adds a favicon to the demo

* Import condensed version logic @agjohnson

* Update sphinx_rtd_theme/layout.html

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc3 (readthedocs#1414)

* Bump version to 1.2.0rc3

* Update changelog with more entries and known issues

* Update package-lock

Do not use sphinxcontrib-jquery 3.0.0 but anticipate a fixed release (readthedocs#1421)

* Do not use sphinxcontrib-jquery but anticipate a fixed release

* Only require sphinxcontrib-jquery on Python 3 (Sphinx 6 isn't released for 2.7)

release 1.2.0rc4 (readthedocs#1430)

* Bump to 1.2.0rc4

* Update changelog

* Update translations

* Chinese (Taiwan) was also a new addition

Release 1.2.0 (readthedocs#1432)

* Drop development version header from changelog

This makes just as much sense as a point release header, and won't
require any special attention when we're cutting a release.

* Bump release 1.2.0

* Update package lock

Bump to next alpha for development (readthedocs#1433)

fixed type-o in note on automatic index generation (readthedocs#1458)

Add a call to add_js_files (sphinxcontrib.query) (readthedocs#1448)

* Add a call to add_js_files since it doesn't happen when loading extension from theme sphinx-contrib/jquery#23

* Avoid importing from sphinxcontrib.jquery in __init__

* Add reference to issue

Docs: Typo in recommended pinning (readthedocs#1476)

* Typo in recommended pinning

The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match

* Update development.rst

Release 1.2.1 (readthedocs#1474)

* Run bump2version

* Add changelog

Contributing updates (readthedocs#1478)

* Add reminder to pull from remote

* Sign git tags

:menuselection: style (readthedocs#1426)

* Adds a bit of basic styling for `:menuselection:`

* Rebuild CSS

* Remove docs demo, there was one already exactly below :)

* Make menuselection color same as guilabel

* Update assets for readthedocs#1426

Remove version logic on sphinxcontrib-jquery, require >=4,<5 (readthedocs#1446)

* Remove version logic on sphinxcontrib-jquery, require >=4,<5

* Bump to Sphinx 6.1.x

* Remove testing for Sphinx 1.7, sphinxcontrib-jquery 4.x blocks it

Release 1.2.2 (readthedocs#1484)

* Changelog for 1.2.2

* 1.2.2rc1

* Build: Fix bug that reads out container id from previous run

* Update package-lock to match release

* Bump to 1.2.2 final

Add Sphinx 7 support (readthedocs#1464)

* Allow Sphinx 7

* Also build theme docs with Sphinx 7

* Add more tests cases on tox.ini

* Increase the Sphinx version for the docs

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Release 1.3.0rc1 (readthedocs#1494)

* Release 1.3.0rc1

* Update lock file

1.3.0rc2 (readthedocs#1495)

The repo is normally bumped to the next up potential release so it
doesn't conflict with the current release.

Release 1.3.0 (readthedocs#1509)

Bump the RC to final
khancyr pushed a commit to khancyr/sphinx_rtd_theme that referenced this pull request Oct 31, 2023
It seems readthedocs#677 never actually got merged into master

Apply suggestions from code review

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>

Add development version back to docs

Update to next development release after 1.0.0

For now, we'll be a bugfix release at 1.0.1 but do anticipate we'll be
adding features this release and will get to 1.1.0.

Requires readthedocs#1230

Use consistent indentation in src/sass/_theme_rst.sass (readthedocs#1234)

Fix typos (readthedocs#1291)

Fix CircleCI config

Build with Node 14 installed through orbs.

Fixes readthedocs#1275

Fix SASS syntax errors from readthedocs#967

This introduced syntax errors that were not picked up in review, the
`:not()` psuedo selector can't lead a selector in SASS.

Pin Jinja to pre-3.1 release

Ignore asdf configuration

Bump to a valid version scheme, bump node-sass for Node 14 support

Docker configuration for dev environment

Remove some text @agjohnson

First updates migrating to docker-compose

Removes Makefile + double FROM in Dockerfile

Fix node.js error in docker runtime, speed up build by not copying the entire context

Use static setuptools metadata

Add rule to remove double margin inside dl's

Remove double margin from all dl's not just last

Remove double margin from all dl's not just last

Add a demo with Python types (regression test for readthedocs#1196), rebuild theme.js

Bump to a valid version scheme, bump node-sass for Node 14 support

Do not bump the version in auto-maintained file package-lock.json

Adds wheel and a command to package bdist_wheel + sdist

Build everything one step at a time

Make note about releasing `package-lock.json`

Do not build the python package in this step

Fixes the fix from readthedocs#1315 - the CSS selector was wrong

Rebuild theme.css with "Fix <kbd> CSS selector readthedocs#1320"

Wrapping up the Docker work, using docker cp again in order to copy assets out of containers

Tune kbd selectors

Exclude option lists from selectors for kbd styling.

Revert change to JS package

This matches the version number in the Python package, and allows
bumpversion to continue working. We can revisit changing this version
later, but currently this version will never be updated again, as
bumpversion will not match this string anymore.

Fixes readthedocs#1326

Fix a wrong example, replace non-existing `Body Elements` with `References`

Add an upper bound for when Sphinx 6 is released

Fix readthedocs#1078: Citation not styled properly (readthedocs#1080)

* Fix readthedocs#1078: Citation not styled properly

Turns out our demo docs werent being rendered by sphinx as citations so this may have slipped though the sphinx 2 fixes.

I updated the demo docs and included the need style fixes.

* Group citations and footnotes

* Build Assets

* Build theme.css with "Fix readthedocs#1078: Citation not styled properly readthedocs#1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Fixes readthedocs#289: Inconsistent table typography sizing (readthedocs#1215)

* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for readthedocs#1215

* Add an example rendering with paragraphs inside tables

* build theme.css for readthedocs#1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Build matrix fixes (readthedocs#1338)

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

Add Python 3.10 support (readthedocs#1334)

* Add Python 3.10 support

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

* Set sphinx versions for Python 3.10

Fix definition lists inside api docs (readthedocs#1084)

* Fix definition lists inside api docs

This is similar to readthedocs#1080 (and is needed to fix citations in the demo here)

Fixes readthedocs#1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for readthedocs#1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Remove font-smoothing (readthedocs#1094)

* Remove font-smoothing

This is a non standard css feature and is not supported on many platforms. And has been removed from the css standard specification.
It is advized to not use it according to MDN along with many other guides on the internet.

* rebuild theme.css and badge_only.css for readthedocs#1094

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

CSS: Add overflow-wrap to links inside paragraphs (readthedocs#1193)

* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for readthedocs#1193

* build theme.css for readthedocs#1193

* Build theme.css for readthedocs#1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Update Breadcrumb Styles (readthedocs#1073)

* Update Breadcrumb Styles

- Fixes extra padding to the left/right
- Used slash instead of >>
- Make literalls match other link style
- Adds demo docs for testing

* Update comment

* Update src/sass/_theme_breadcrumbs.sass

Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

* Build theme.css for readthedocs#1073

* Build theme.css for readthedocs#1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

Fixup a wrong merge conflict resolution from readthedocs#1321 (readthedocs#1335)

* Fixup a wrong merge conflict resolution from readthedocs#1321

* Add python_requires again to setup.cfg

Add sphinx 5.2 to test matrix (readthedocs#1348)

Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)

* Update layout.html to support a sphinx version that is not three-integers. Useful for sphinx==5.2.0.post0

* Apply suggestions from code review

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* No reason to only have the first three elements from the sphinx version

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>

Translation updates: Pull translations from transifex, push new sources (readthedocs#1354)

Adds changelog for 1.1.0alpha1 (readthedocs#1353)

* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Additions to Tox and Circle CI matrix (readthedocs#1349)

* Refines tox matrix, adds a new target "sphinxdev" that can test the latest upstream development branch

* Adds missing tox environments in circle ci config

* Remove odd undefined py2 and py3 tox environments

Move context logic for layout.html to jinja (readthedocs#1356)

* Revert "Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)"

This reverts commit 45cf218.

* Always slice list before unpacking so number of elements is expected range

`map` filter returns a generator that needs to run through the `list` filter before slicing

* Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values

Release 1.1.0b1 + 1.1.0b2 (bump versions with bump2version) (readthedocs#1352)

* Bump to 1.1.0 using bump2version

* Use PEP440 and make it a beta, i.e. "1.1.0b1"

* Auto-generated package-lock.json but with version bumps

* Bump to 1.1.0b2, rebuild assets

Remove Jinja2 dependency (readthedocs#1360)

* Remove Jinja2 dependency, inherited from Sphinx + handled in external environments

* Remove mentioning of Jinja2 dependency change

* Add Jinja2<3.1 dependecy to affected tox environments

Release 1.1.0b3 (readthedocs#1361)

* Update __init__.py because it wasn't updated by previous bump2version

* Add some comments about docker mechanisms that are disturbing release workflow

* Bump to version 1.1.0b3

* Revert "Bump to 1.1.0b2, rebuild assets"

This reverts commit 615eb52.

* Add changelog entry for readthedocs#1073

* Changelog entry for readthedocs#1193

Bump to version 1.1.0 (readthedocs#1367)

Do not overflow object cross references (readthedocs#1369)

* Do not overflow object cross references

* Rebuild theme for readthedocs#1369

* Adds a demo for the regression

* Mock sphinx-automodapi for now, but we can use it soon

* we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood

* We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0.

* Add comment about the terrible tox workaround

* Use a less hacky way of conditional autosummary in demo API docs

- Use `only` directive for conditional reST instead
- Drops 1.6 from our text matrix, it was deprecated in 1.0 release.
  There were issues with the conditional directive only on 1.6 for some
  reason.

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Bugfix release 1.1.1 (readthedocs#1371)

* Bugfix release 1.1.1

* Release package updates

* Package lock
* Translations

Bump development version after 1.1.1 release (readthedocs#1372)

Update versioning docs to be explicit about our versioning workflow (readthedocs#1373)

Docs: Add upgrade instructions and simplify conf.py (readthedocs#1365)

* Docs: Clean up several broken cross-references

* Adds a section about upgrading the theme and add navigation structure to installation guide

* Add a reference from Changelog to "How to upgrade"

* Also don't import sphinx_rtd_theme in the theme's own docs/conf.py

* Remove trailing linebreaks

* Update docs/installing.rst

Co-authored-by: Anthony <aj@ohess.org>

* Apply suggestions from code review

Co-authored-by: Anthony <aj@ohess.org>

* Update docs/installing.rst

* Replace guidance with reference to Reproducible Builds

* Build link into sentence

* Update the tip about using build logs and the need to pin the theme for older projects

* Remove tip box for Read the Docs users re: @agjohnson's request

Co-authored-by: Anthony <aj@ohess.org>

New release of sphinxcontrib-httpdomain==1.8.1 broke tests (readthedocs#1383)

* New release of sphinxcontrib-httpdomain==1.8.1 broke tests

* Remove sphinxcontrib-httpdomain

Eager upgrade of all dependencies in docker development environment (readthedocs#1350)

* Do an eager upgrade of all dependencies in docker development environment

* Adds a comment about installation of deps and upgrade strategy

Added aria-label to search box input field. (readthedocs#1380)

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Added hidden text for home link in the breadcrumbs. (readthedocs#1384)

* Added hidden text for home link in breadcrumbs.

* Update breadcrumbs.html

* Update breadcrumbs.html

Add docutils 0.18 citation/footnote support using CSS grid (readthedocs#1381)

* Add docutils 0.18 citation/footnote support using CSS grid

This is a fix for readthedocs#1322 that continues our pattern for HTML5 support
using CSS grids, introduced for support for docutils < 0.17 HTML5
support.

* Add lots of backreferences to a footnote

* Drop brackets from footnote/citation links

The brackets seem to be another docutils addition.

* Tune grid display for Sphinx 4 and 5

Backrefs have a new styling that drops a lot of punctuation

* Bump dependency on docutils to < 0.19

* Small tweak to footnote backrefs row span

We don't want to use too large a value here, as some browsers might make
explicit rows for us. We can't target -1 because the row count is
implicit.

* Revert some new styling and use nonbreaking backrefs for now

* Downgrade tox

* Use before pseudo class to break up backrefs consistently

Add changelog entry for docutils 0.18 support (readthedocs#1389)

* Add changelog entry for docutils 0.18 support

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc1 (readthedocs#1391)

* Bump to 1.2.0alpha1

* bump 2 1.2.0rc1

* Update package-lock.json from nmp audit

* Sync translations from Transifex (no changes found though)

Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery (readthedocs#1385)

* Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery

* Adds Sphinx 6.0b2 to Tox test matrix

* Adds Sphinx 6 to relevant Circle CI pipelines

* Build docs with Sphinx 6.0b2

* Use stable Sphinx 6.0.0

support Python 3.11 with Sphinx 5.3+ (readthedocs#1395)

* support Python 3.11 with Sphinx 5.3+

* Update tox.ini

Co-authored-by: Michael R. Crusoe <1330696+mr-c@users.noreply.github.com>

Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>
Co-authored-by: Benjamin Balder Bach <benjaoming@gmail.com>

sphinx-rtd-theme will automatically enable sphinxcontrib-jquery (readthedocs#1399)

1.2.0rc2 (readthedocs#1397)

* Bump to 1.2.0rc2, add changelog entry on Sphinx 6

* Pull translations (no changes)

* loosen sphinx 6 pinning

Updates to package-lock.json for 1.2.0rc2 (readthedocs#1400)

Updates to package-lock.json

Sphinx 6: Use logo_url instead of logo (readthedocs#1405)

* Sphinx 6: Use logo_url instead of logo

* Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0

* Adds a favicon to the demo

* Import condensed version logic @agjohnson

* Update sphinx_rtd_theme/layout.html

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc3 (readthedocs#1414)

* Bump version to 1.2.0rc3

* Update changelog with more entries and known issues

* Update package-lock

Do not use sphinxcontrib-jquery 3.0.0 but anticipate a fixed release (readthedocs#1421)

* Do not use sphinxcontrib-jquery but anticipate a fixed release

* Only require sphinxcontrib-jquery on Python 3 (Sphinx 6 isn't released for 2.7)

release 1.2.0rc4 (readthedocs#1430)

* Bump to 1.2.0rc4

* Update changelog

* Update translations

* Chinese (Taiwan) was also a new addition

Release 1.2.0 (readthedocs#1432)

* Drop development version header from changelog

This makes just as much sense as a point release header, and won't
require any special attention when we're cutting a release.

* Bump release 1.2.0

* Update package lock

Bump to next alpha for development (readthedocs#1433)

fixed type-o in note on automatic index generation (readthedocs#1458)

Add a call to add_js_files (sphinxcontrib.query) (readthedocs#1448)

* Add a call to add_js_files since it doesn't happen when loading extension from theme sphinx-contrib/jquery#23

* Avoid importing from sphinxcontrib.jquery in __init__

* Add reference to issue

Docs: Typo in recommended pinning (readthedocs#1476)

* Typo in recommended pinning

The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match

* Update development.rst

Release 1.2.1 (readthedocs#1474)

* Run bump2version

* Add changelog

Contributing updates (readthedocs#1478)

* Add reminder to pull from remote

* Sign git tags

:menuselection: style (readthedocs#1426)

* Adds a bit of basic styling for `:menuselection:`

* Rebuild CSS

* Remove docs demo, there was one already exactly below :)

* Make menuselection color same as guilabel

* Update assets for readthedocs#1426

Remove version logic on sphinxcontrib-jquery, require >=4,<5 (readthedocs#1446)

* Remove version logic on sphinxcontrib-jquery, require >=4,<5

* Bump to Sphinx 6.1.x

* Remove testing for Sphinx 1.7, sphinxcontrib-jquery 4.x blocks it

Release 1.2.2 (readthedocs#1484)

* Changelog for 1.2.2

* 1.2.2rc1

* Build: Fix bug that reads out container id from previous run

* Update package-lock to match release

* Bump to 1.2.2 final

Add Sphinx 7 support (readthedocs#1464)

* Allow Sphinx 7

* Also build theme docs with Sphinx 7

* Add more tests cases on tox.ini

* Increase the Sphinx version for the docs

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Release 1.3.0rc1 (readthedocs#1494)

* Release 1.3.0rc1

* Update lock file

1.3.0rc2 (readthedocs#1495)

The repo is normally bumped to the next up potential release so it
doesn't conflict with the current release.

Release 1.3.0 (readthedocs#1509)

Bump the RC to final
khancyr added a commit to khancyr/sphinx_rtd_theme that referenced this pull request Oct 31, 2023
It seems readthedocs#677 never actually got merged into master

Apply suggestions from code review

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>

Add development version back to docs

Update to next development release after 1.0.0

For now, we'll be a bugfix release at 1.0.1 but do anticipate we'll be
adding features this release and will get to 1.1.0.

Requires readthedocs#1230

Use consistent indentation in src/sass/_theme_rst.sass (readthedocs#1234)

Fix typos (readthedocs#1291)

Fix CircleCI config

Build with Node 14 installed through orbs.

Fixes readthedocs#1275

Fix SASS syntax errors from readthedocs#967

This introduced syntax errors that were not picked up in review, the
`:not()` psuedo selector can't lead a selector in SASS.

Pin Jinja to pre-3.1 release

Ignore asdf configuration

Bump to a valid version scheme, bump node-sass for Node 14 support

Docker configuration for dev environment

Remove some text @agjohnson

First updates migrating to docker-compose

Removes Makefile + double FROM in Dockerfile

Fix node.js error in docker runtime, speed up build by not copying the entire context

Use static setuptools metadata

Add rule to remove double margin inside dl's

Remove double margin from all dl's not just last

Remove double margin from all dl's not just last

Add a demo with Python types (regression test for readthedocs#1196), rebuild theme.js

Bump to a valid version scheme, bump node-sass for Node 14 support

Do not bump the version in auto-maintained file package-lock.json

Adds wheel and a command to package bdist_wheel + sdist

Build everything one step at a time

Make note about releasing `package-lock.json`

Do not build the python package in this step

Fixes the fix from readthedocs#1315 - the CSS selector was wrong

Rebuild theme.css with "Fix <kbd> CSS selector readthedocs#1320"

Wrapping up the Docker work, using docker cp again in order to copy assets out of containers

Tune kbd selectors

Exclude option lists from selectors for kbd styling.

Revert change to JS package

This matches the version number in the Python package, and allows
bumpversion to continue working. We can revisit changing this version
later, but currently this version will never be updated again, as
bumpversion will not match this string anymore.

Fixes readthedocs#1326

Fix a wrong example, replace non-existing `Body Elements` with `References`

Add an upper bound for when Sphinx 6 is released

Fix readthedocs#1078: Citation not styled properly (readthedocs#1080)

* Fix readthedocs#1078: Citation not styled properly

Turns out our demo docs werent being rendered by sphinx as citations so this may have slipped though the sphinx 2 fixes.

I updated the demo docs and included the need style fixes.

* Group citations and footnotes

* Build Assets

* Build theme.css with "Fix readthedocs#1078: Citation not styled properly readthedocs#1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Fixes readthedocs#289: Inconsistent table typography sizing (readthedocs#1215)

* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for readthedocs#1215

* Add an example rendering with paragraphs inside tables

* build theme.css for readthedocs#1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Build matrix fixes (readthedocs#1338)

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

Add Python 3.10 support (readthedocs#1334)

* Add Python 3.10 support

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

* Set sphinx versions for Python 3.10

Fix definition lists inside api docs (readthedocs#1084)

* Fix definition lists inside api docs

This is similar to readthedocs#1080 (and is needed to fix citations in the demo here)

Fixes readthedocs#1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for readthedocs#1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Remove font-smoothing (readthedocs#1094)

* Remove font-smoothing

This is a non standard css feature and is not supported on many platforms. And has been removed from the css standard specification.
It is advized to not use it according to MDN along with many other guides on the internet.

* rebuild theme.css and badge_only.css for readthedocs#1094

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

CSS: Add overflow-wrap to links inside paragraphs (readthedocs#1193)

* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for readthedocs#1193

* build theme.css for readthedocs#1193

* Build theme.css for readthedocs#1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Update Breadcrumb Styles (readthedocs#1073)

* Update Breadcrumb Styles

- Fixes extra padding to the left/right
- Used slash instead of >>
- Make literalls match other link style
- Adds demo docs for testing

* Update comment

* Update src/sass/_theme_breadcrumbs.sass

Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

* Build theme.css for readthedocs#1073

* Build theme.css for readthedocs#1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

Fixup a wrong merge conflict resolution from readthedocs#1321 (readthedocs#1335)

* Fixup a wrong merge conflict resolution from readthedocs#1321

* Add python_requires again to setup.cfg

Add sphinx 5.2 to test matrix (readthedocs#1348)

Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)

* Update layout.html to support a sphinx version that is not three-integers. Useful for sphinx==5.2.0.post0

* Apply suggestions from code review

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* No reason to only have the first three elements from the sphinx version

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>

Translation updates: Pull translations from transifex, push new sources (readthedocs#1354)

Adds changelog for 1.1.0alpha1 (readthedocs#1353)

* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Additions to Tox and Circle CI matrix (readthedocs#1349)

* Refines tox matrix, adds a new target "sphinxdev" that can test the latest upstream development branch

* Adds missing tox environments in circle ci config

* Remove odd undefined py2 and py3 tox environments

Move context logic for layout.html to jinja (readthedocs#1356)

* Revert "Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)"

This reverts commit 45cf218.

* Always slice list before unpacking so number of elements is expected range

`map` filter returns a generator that needs to run through the `list` filter before slicing

* Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values

Release 1.1.0b1 + 1.1.0b2 (bump versions with bump2version) (readthedocs#1352)

* Bump to 1.1.0 using bump2version

* Use PEP440 and make it a beta, i.e. "1.1.0b1"

* Auto-generated package-lock.json but with version bumps

* Bump to 1.1.0b2, rebuild assets

Remove Jinja2 dependency (readthedocs#1360)

* Remove Jinja2 dependency, inherited from Sphinx + handled in external environments

* Remove mentioning of Jinja2 dependency change

* Add Jinja2<3.1 dependecy to affected tox environments

Release 1.1.0b3 (readthedocs#1361)

* Update __init__.py because it wasn't updated by previous bump2version

* Add some comments about docker mechanisms that are disturbing release workflow

* Bump to version 1.1.0b3

* Revert "Bump to 1.1.0b2, rebuild assets"

This reverts commit 615eb52.

* Add changelog entry for readthedocs#1073

* Changelog entry for readthedocs#1193

Bump to version 1.1.0 (readthedocs#1367)

Do not overflow object cross references (readthedocs#1369)

* Do not overflow object cross references

* Rebuild theme for readthedocs#1369

* Adds a demo for the regression

* Mock sphinx-automodapi for now, but we can use it soon

* we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood

* We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0.

* Add comment about the terrible tox workaround

* Use a less hacky way of conditional autosummary in demo API docs

- Use `only` directive for conditional reST instead
- Drops 1.6 from our text matrix, it was deprecated in 1.0 release.
  There were issues with the conditional directive only on 1.6 for some
  reason.

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Bugfix release 1.1.1 (readthedocs#1371)

* Bugfix release 1.1.1

* Release package updates

* Package lock
* Translations

Bump development version after 1.1.1 release (readthedocs#1372)

Update versioning docs to be explicit about our versioning workflow (readthedocs#1373)

Docs: Add upgrade instructions and simplify conf.py (readthedocs#1365)

* Docs: Clean up several broken cross-references

* Adds a section about upgrading the theme and add navigation structure to installation guide

* Add a reference from Changelog to "How to upgrade"

* Also don't import sphinx_rtd_theme in the theme's own docs/conf.py

* Remove trailing linebreaks

* Update docs/installing.rst

Co-authored-by: Anthony <aj@ohess.org>

* Apply suggestions from code review

Co-authored-by: Anthony <aj@ohess.org>

* Update docs/installing.rst

* Replace guidance with reference to Reproducible Builds

* Build link into sentence

* Update the tip about using build logs and the need to pin the theme for older projects

* Remove tip box for Read the Docs users re: @agjohnson's request

Co-authored-by: Anthony <aj@ohess.org>

New release of sphinxcontrib-httpdomain==1.8.1 broke tests (readthedocs#1383)

* New release of sphinxcontrib-httpdomain==1.8.1 broke tests

* Remove sphinxcontrib-httpdomain

Eager upgrade of all dependencies in docker development environment (readthedocs#1350)

* Do an eager upgrade of all dependencies in docker development environment

* Adds a comment about installation of deps and upgrade strategy

Added aria-label to search box input field. (readthedocs#1380)

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Added hidden text for home link in the breadcrumbs. (readthedocs#1384)

* Added hidden text for home link in breadcrumbs.

* Update breadcrumbs.html

* Update breadcrumbs.html

Add docutils 0.18 citation/footnote support using CSS grid (readthedocs#1381)

* Add docutils 0.18 citation/footnote support using CSS grid

This is a fix for readthedocs#1322 that continues our pattern for HTML5 support
using CSS grids, introduced for support for docutils < 0.17 HTML5
support.

* Add lots of backreferences to a footnote

* Drop brackets from footnote/citation links

The brackets seem to be another docutils addition.

* Tune grid display for Sphinx 4 and 5

Backrefs have a new styling that drops a lot of punctuation

* Bump dependency on docutils to < 0.19

* Small tweak to footnote backrefs row span

We don't want to use too large a value here, as some browsers might make
explicit rows for us. We can't target -1 because the row count is
implicit.

* Revert some new styling and use nonbreaking backrefs for now

* Downgrade tox

* Use before pseudo class to break up backrefs consistently

Add changelog entry for docutils 0.18 support (readthedocs#1389)

* Add changelog entry for docutils 0.18 support

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc1 (readthedocs#1391)

* Bump to 1.2.0alpha1

* bump 2 1.2.0rc1

* Update package-lock.json from nmp audit

* Sync translations from Transifex (no changes found though)

Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery (readthedocs#1385)

* Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery

* Adds Sphinx 6.0b2 to Tox test matrix

* Adds Sphinx 6 to relevant Circle CI pipelines

* Build docs with Sphinx 6.0b2

* Use stable Sphinx 6.0.0

support Python 3.11 with Sphinx 5.3+ (readthedocs#1395)

* support Python 3.11 with Sphinx 5.3+

* Update tox.ini

Co-authored-by: Michael R. Crusoe <1330696+mr-c@users.noreply.github.com>

Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>
Co-authored-by: Benjamin Balder Bach <benjaoming@gmail.com>

sphinx-rtd-theme will automatically enable sphinxcontrib-jquery (readthedocs#1399)

1.2.0rc2 (readthedocs#1397)

* Bump to 1.2.0rc2, add changelog entry on Sphinx 6

* Pull translations (no changes)

* loosen sphinx 6 pinning

Updates to package-lock.json for 1.2.0rc2 (readthedocs#1400)

Updates to package-lock.json

Sphinx 6: Use logo_url instead of logo (readthedocs#1405)

* Sphinx 6: Use logo_url instead of logo

* Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0

* Adds a favicon to the demo

* Import condensed version logic @agjohnson

* Update sphinx_rtd_theme/layout.html

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Release 1.2.0rc3 (readthedocs#1414)

* Bump version to 1.2.0rc3

* Update changelog with more entries and known issues

* Update package-lock

Do not use sphinxcontrib-jquery 3.0.0 but anticipate a fixed release (readthedocs#1421)

* Do not use sphinxcontrib-jquery but anticipate a fixed release

* Only require sphinxcontrib-jquery on Python 3 (Sphinx 6 isn't released for 2.7)

release 1.2.0rc4 (readthedocs#1430)

* Bump to 1.2.0rc4

* Update changelog

* Update translations

* Chinese (Taiwan) was also a new addition

Release 1.2.0 (readthedocs#1432)

* Drop development version header from changelog

This makes just as much sense as a point release header, and won't
require any special attention when we're cutting a release.

* Bump release 1.2.0

* Update package lock

Bump to next alpha for development (readthedocs#1433)

fixed type-o in note on automatic index generation (readthedocs#1458)

Add a call to add_js_files (sphinxcontrib.query) (readthedocs#1448)

* Add a call to add_js_files since it doesn't happen when loading extension from theme sphinx-contrib/jquery#23

* Avoid importing from sphinxcontrib.jquery in __init__

* Add reference to issue

Docs: Typo in recommended pinning (readthedocs#1476)

* Typo in recommended pinning

The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match

* Update development.rst

Release 1.2.1 (readthedocs#1474)

* Run bump2version

* Add changelog

Contributing updates (readthedocs#1478)

* Add reminder to pull from remote

* Sign git tags

:menuselection: style (readthedocs#1426)

* Adds a bit of basic styling for `:menuselection:`

* Rebuild CSS

* Remove docs demo, there was one already exactly below :)

* Make menuselection color same as guilabel

* Update assets for readthedocs#1426

Remove version logic on sphinxcontrib-jquery, require >=4,<5 (readthedocs#1446)

* Remove version logic on sphinxcontrib-jquery, require >=4,<5

* Bump to Sphinx 6.1.x

* Remove testing for Sphinx 1.7, sphinxcontrib-jquery 4.x blocks it

Release 1.2.2 (readthedocs#1484)

* Changelog for 1.2.2

* 1.2.2rc1

* Build: Fix bug that reads out container id from previous run

* Update package-lock to match release

* Bump to 1.2.2 final

Add Sphinx 7 support (readthedocs#1464)

* Allow Sphinx 7

* Also build theme docs with Sphinx 7

* Add more tests cases on tox.ini

* Increase the Sphinx version for the docs

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Release 1.3.0rc1 (readthedocs#1494)

* Release 1.3.0rc1

* Update lock file

1.3.0rc2 (readthedocs#1495)

The repo is normally bumped to the next up potential release so it
doesn't conflict with the current release.

Release 1.3.0 (readthedocs#1509)

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

Successfully merging this pull request may close these issues.

Problems with bumpversion
2 participants