Update versioning docs to be explicit about our versioning workflow #1373

agjohnson · 2022-11-04T19:40:38Z

The versioning pattern we used last release didn't quite match our normal workflow, so I've made directions explicit. We ended up with a b release somehow (1.1.0b3), I'm assuming this was manually edited it.

Related to #1372

benjaoming · 2022-11-04T20:27:24Z

Is this addressing the version string's format (b instead of beta) or maintaining version strings in-between releases (development versions)?

I have some vague experience of setuptools/pip automatically changing 1.1.0beta3 to 1.1.0b3? I think there's some magick that makes things PEP440 compliant, not sure.

agjohnson · 2022-11-04T21:11:09Z

It's addressing using beta at all actually, the current bump2version config does not use beta:

https://github.com/readthedocs/sphinx_rtd_theme/blob/master/setup.cfg#L94-L100

Progression is alpha -> rc -> release, which is effectively None (stable release)

This is fine, we only do one, maybe two release candidates before stable release.

benjaoming · 2022-11-04T23:05:46Z

That's fine, I mean the label of the pre-release could appeal to make people want to test it and give feedback.. and I think we can be in a good position if we release more early alphas and switch to rc once the milestone is reached 👍

benjaoming · 2022-11-04T23:23:47Z

docs/contributing.rst

+..
+    TODO make these instructions organization wide. We've talked about
+    standardizing packaging version and tooling here (bumpver instead of
+    bump2version).


I'm not sure if I would make this organization-wide. It can vary for every project. Release processes also lean towards automation, although I'm not a big fan.

For this project, we could work more with dynamic generation of artifacts for each release.

A versioning guide should contain more details on the semantics of the versions. For instance, can a patch release contain translations? What can be changed in a minor release? How do we handle deprecation? Etc.

agjohnson · 2022-11-05T00:43:10Z

we release more early alphas and switch to rc

We don't/wouldn't release an alpha version to PyPI. These version numbers only exist in the repository. If we are pushing to PyPI, it should be an rc release.

benjaoming · 2022-11-05T21:47:57Z

I think it's useful to have as many public releases as possible, as long as they are clearly labeled for testing purposes.

The hypothesis would be that if we can start to release development versions on PyPi as early as possible, we can hopefully have a bit more quality assurance 👍

agjohnson · 2022-11-07T17:56:41Z

I'm not proposing fewer PyPI releases. I'm saying our releases should be labeled rc releases, not alpha. The alpha label is reserved for development between releases. This is not my plan, it is the versioning scheme we added with the switch to bump2verison.

benjaoming · 2022-11-07T20:07:23Z

Yes, but I think we should release more of that "development between releases" to make it more accessible to test 👍

agjohnson · 2022-11-07T21:54:13Z

What you're describing is releasing with a faster cadence. We don't need to release alpha releases and rc releases. In fact releasing both is probably a signal that our releases are too large in scope, frequent rc release should be sufficient.

If we have enough merged to put out a release, it should go out as an rc. The trap that we continue to get sucked into is creeping the scope of a release until it takes too much bandwidth to test and release, and then snowballing the issue by building on unreleased code.

benjaoming · 2022-11-07T22:16:43Z

A release candidate is normally something that has all intended changes ready and will get promoted to a stable release if no bugs are found.

I'm talking about making more releases from the development branch (what is currently master). So after a significant PR, we do an alpha. Once we have all PRs for a milestone, we do an rc. To make this conversation simpler, I'm trying to not bring in any new definitions, but to suggest something that seems to fit with the current state of affairs.

For instance for the 1.2 milestone, we want docutils 0.18.. after that feature is merged, I think we should release something. But we will also continue to work on Sphinx 6 support w/ sphinxcontrib-jquery before a 1.2 rc1 is released.

Does the example make sense or do you want an rc label even on releases that are going to significantly change?

agjohnson · 2022-11-08T00:39:16Z

Does the example make sense or do you want an rc label even on releases that are going to significantly change?

I am describing cutting smaller, more frequent releases using rc labeled releases. Releasing alphas after PRs is way too much overhead and will steal our attention and time away from putting out stable releases more often. This is all part of a discussion we've already had around our release procedure and we nixed the idea of frequent beta releases to PyPI.

benjaoming · 2022-11-08T12:37:19Z

I understand that we could force more frequent releases by having fewer changes forcing out more rcs that we quickly promote to stable releases.

However, with the milestones implied by the roadmap, I think it's a little off to have rc labeling on all pre-releases that would follow from each PR generated by the roadmap. On the other hand not doing pre-releases for each of the larger PRs is ruling out the potential of community involvement.

Aside from the roadmap, we also have a large hump of PRs that would be nice to be able to have a good way to work on.

With a sign-off on closed issues and PRs like "Thank you for your contributions! The change is now out for testing in a pre-release. Please help us test this the latest 1.2.3rc5 in your documentation project." <= for the 1.2.0, 2.0 and 3.0 milestones, I want alpha or beta to come before rc so it's easy to ship pre-releases that are correctly labeled.

Releasing alphas after PRs is way too much overhead and will steal our attention and time away from putting out stable releases more often.

I understand that I'm basically contradicting what you say has already been discussed and nixed. But look at the roadmap, it proposes a lot of changes and perhaps it'd be nice to leverage from the community that's around to help verifying releases.

Putting pre-releases out often is also supportive of putting stable releases out often, for instance new maintainers can get more practice :) I think having more pre-releases can be a good way to get more testing and feedback, and especially with the involvement of people in issues and PRs. I think that we already gone over the manual barriers of putting together releases, but that's also something we'll get to improve with a bit more automation 👍

agjohnson · 2022-11-08T16:44:09Z

it'd be nice to leverage from the community that's around to help verifying releases.

There is nothing in our current plan that stops this. Aiming for alpha, beta, then rc releases is over-engineering this problem and is way more work than we can allocate to this project.

That is, if we want to get a fix out so that a user can test the fix, our release process should be streamlined enough that we can cut a final release or an rc release. Cutting alpha releases is a sign that we've delayed the release too long.

agjohnson · 2022-11-08T22:06:18Z

I'm moving the organization wide discussion here https://github.com/readthedocs/meta/discussions/87

@agjohnson

It seems readthedocs#677 never actually got merged into master Apply suggestions from code review Co-authored-by: Jesse Tan <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> * Build theme.css for readthedocs#1073 * Build theme.css for readthedocs#1073 Co-authored-by: Benjamin Bach <[email protected]> Co-authored-by: Ana Costa <[email protected]> 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 <[email protected]> * No reason to only have the first three elements from the sphinx version Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Anthony Johnson <[email protected]> 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 <[email protected]> * Apply suggestions from code review Co-authored-by: Anthony <[email protected]> * 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> 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

@agjohnson

It seems readthedocs#677 never actually got merged into master Apply suggestions from code review Co-authored-by: Jesse Tan <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> * Build theme.css for readthedocs#1073 * Build theme.css for readthedocs#1073 Co-authored-by: Benjamin Bach <[email protected]> Co-authored-by: Ana Costa <[email protected]> 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 <[email protected]> * No reason to only have the first three elements from the sphinx version Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Anthony Johnson <[email protected]> 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 <[email protected]> * Apply suggestions from code review Co-authored-by: Anthony <[email protected]> * 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> 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

@agjohnson

It seems readthedocs#677 never actually got merged into master Apply suggestions from code review Co-authored-by: Jesse Tan <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> * Build theme.css for readthedocs#1073 * Build theme.css for readthedocs#1073 Co-authored-by: Benjamin Bach <[email protected]> Co-authored-by: Ana Costa <[email protected]> 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 <[email protected]> * No reason to only have the first three elements from the sphinx version Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Anthony Johnson <[email protected]> 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 <[email protected]> * Apply suggestions from code review Co-authored-by: Anthony <[email protected]> * 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 <[email protected]> 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 <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]> 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 <[email protected]> Co-authored-by: Anthony <[email protected]> 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 <[email protected]> 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

Update versioning docs to be explicit about our versioning workflow

65ce2e6

agjohnson requested a review from a team as a code owner November 4, 2022 19:40

benjaoming approved these changes Nov 4, 2022

View reviewed changes

benjaoming merged commit bef1649 into master Nov 4, 2022

benjaoming deleted the agj/update-versioning-docs branch November 4, 2022 23:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update versioning docs to be explicit about our versioning workflow #1373

Update versioning docs to be explicit about our versioning workflow #1373

agjohnson commented Nov 4, 2022 •

edited

Loading

benjaoming commented Nov 4, 2022

agjohnson commented Nov 4, 2022 •

edited

Loading

benjaoming commented Nov 4, 2022

benjaoming Nov 4, 2022

agjohnson commented Nov 5, 2022

benjaoming commented Nov 5, 2022

agjohnson commented Nov 7, 2022 •

edited

Loading

benjaoming commented Nov 7, 2022

agjohnson commented Nov 7, 2022 •

edited

Loading

benjaoming commented Nov 7, 2022

agjohnson commented Nov 8, 2022

benjaoming commented Nov 8, 2022 •

edited

Loading

agjohnson commented Nov 8, 2022 •

edited

Loading

agjohnson commented Nov 8, 2022

Update versioning docs to be explicit about our versioning workflow #1373

Update versioning docs to be explicit about our versioning workflow #1373

Conversation

agjohnson commented Nov 4, 2022 • edited Loading

benjaoming commented Nov 4, 2022

agjohnson commented Nov 4, 2022 • edited Loading

benjaoming commented Nov 4, 2022

benjaoming Nov 4, 2022

Choose a reason for hiding this comment

agjohnson commented Nov 5, 2022

benjaoming commented Nov 5, 2022

agjohnson commented Nov 7, 2022 • edited Loading

benjaoming commented Nov 7, 2022

agjohnson commented Nov 7, 2022 • edited Loading

benjaoming commented Nov 7, 2022

agjohnson commented Nov 8, 2022

benjaoming commented Nov 8, 2022 • edited Loading

agjohnson commented Nov 8, 2022 • edited Loading

agjohnson commented Nov 8, 2022

agjohnson commented Nov 4, 2022 •

edited

Loading

agjohnson commented Nov 4, 2022 •

edited

Loading

agjohnson commented Nov 7, 2022 •

edited

Loading

agjohnson commented Nov 7, 2022 •

edited

Loading

benjaoming commented Nov 8, 2022 •

edited

Loading

agjohnson commented Nov 8, 2022 •

edited

Loading