Changelog

Version 9.13.0

Date:

May 23, 2023

Version 9.12.0

Date:

May 02, 2023

Version 9.11.0

Date:

April 18, 2023

Version 9.10.1

Date:

April 11, 2023

Version 9.10.0

Date:

March 28, 2023

Version 9.9.1

Date:

March 21, 2023

Version 9.9.0

Date:

March 14, 2023

Version 9.8.0

Date:

March 07, 2023

Version 9.7.0

This release contains one security fix. For more information, see:

Date:

February 28, 2023

Version 9.6.0

Date:

February 21, 2023

Version 9.5.0

This release contains one security fix. For more information, see:

Date:

February 13, 2023

Version 9.4.0

This release contains one security fix. For more information, see:

Date:

February 07, 2023

Version 9.3.1

Date:

January 30, 2023

Version 9.3.0

Date:

January 24, 2023

Version 9.2.0

This release contains two security fixes. For more information, see our GitHub advisories:

Date:

January 16, 2023

Version 9.1.3

Date:

January 10, 2023

Version 9.1.2

Date:

January 03, 2023

Version 9.1.1

Date:

December 20, 2022

Version 9.1.0

This release contains an important security fix. See more information on the GitHub advisory.

Date:

December 08, 2022

Version 9.0.0

This version upgrades our Search API experience to a v3.

Date:

November 28, 2022

Version 8.9.0

Date:

November 15, 2022

Version 8.8.1

This release contains a security fix, which is the most important part of the update.

Date:

November 09, 2022

Version 8.8.0

Date:

November 08, 2022

Version 8.7.1

Date:

October 24, 2022

Version 8.7.0

Date:

October 11, 2022

Version 8.6.0

Date:

September 28, 2022

Version 8.5.0

Date:

September 12, 2022

Version 8.4.3

Date:

September 06, 2022

Version 8.4.2

Date:

August 29, 2022

Version 8.4.1

Date:

August 23, 2022

Version 8.4.0

Date:

August 16, 2022

Version 8.3.7

Date:

August 09, 2022

  • @stsewd: Sphinx domain: change type of ID field (#9482)

  • @humitos: Build: unpin Pillow for unsupported Python versions (#9473)

  • @humitos: Release 8.3.6 (#9465)

  • @stsewd: Redirects: check only for hostname and path for infinite redirects (#9463)

  • @benjaoming: Fix missing indentation on reStructuredText badge code (#9404)

  • @stsewd: Embed JS: fix incompatibilities with sphinx 6.x (jquery removal) (#9359)

Version 8.3.6

Date:

August 02, 2022

Version 8.3.5

Date:

July 25, 2022

Version 8.3.4

Date:

July 19, 2022

Version 8.3.3

Date:

July 12, 2022

Version 8.3.2

Date:

July 05, 2022

Version 8.3.1

Date:

June 27, 2022

Version 8.3.0

Date:

June 20, 2022

Version 8.2.0

Date:

June 14, 2022

Version 8.1.2

Date:

June 06, 2022

Version 8.1.1

Date:

Jun 1, 2022

Version 8.1.0

Date:

May 24, 2022

Version 8.0.2

Date:

May 16, 2022

Version 8.0.1

Date:

May 09, 2022

Version 8.0.0

Date:

May 03, 2022

Note

We are upgrading to Ubuntu 22.04 LTS and also to Python 3.10.

Projects using Mamba with the old feature flag, and now removed, CONDA_USES_MAMBA, have to update their .readthedocs.yaml file to use build.tools.python: mambaforge-4.10 to continue using Mamba to create their environment. See more about build.tools.python at https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python

Version 7.6.2

Date:

April 25, 2022

Version 7.6.1

Date:

April 19, 2022

Version 7.6.0

Date:

April 12, 2022

Version 7.5.1

Date:

April 04, 2022

Version 7.5.0

Date:

March 28, 2022

Version 7.4.2

Date:

March 14, 2022

Version 7.4.1

Date:

March 07, 2022

  • @humitos: Upgrade common submodule (#9001)

  • @humitos: Build: RepositoryError message (#8999)

  • @humitos: Requirements: remove django-permissions-policy (#8987)

  • @stsewd: Archive builds: avoid filtering by commands__isnull (#8986)

  • @humitos: Build: cancel error message (#8984)

  • @humitos: API: validate RemoteRepository when creating a Project (#8983)

  • @humitos: Celery: trigger archive_builds frequently with a lower limit (#8981)

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 09 (#8977)

  • @stsewd: MkDocs: allow None on extra_css/extra_javascript (#8976)

  • @stsewd: CDN: avoid cache tags collision (#8969)

  • @stsewd: Docs: warn about custom domains on subprojects (#8945)

  • @humitos: Code style: format the code using darker (#8875)

  • @dogukanteber: Use django-storages’ manifest files class instead of the overriden class (#8781)

  • @nienn: Docs: Add links to documentation on creating custom classes (#8466)

  • @stsewd: Integrations: allow to pass more data about external versions (#7692)

Version 7.4.0

Date:

March 01, 2022

Version 7.3.0

Date:

February 21, 2022

Version 7.2.1

Date:

February 15, 2022

Version 7.2.0

Date:

February 08, 2022

Version 7.1.2

Date:

January 31, 2022

Version 7.1.1

Date:

January 31, 2022

Version 7.1.0

Date:

January 25, 2022

Version 7.0.0

This is our 7th major version! This is because we are upgrading to Django 3.2 LTS.

Date:

January 17, 2022

Version 6.3.3

Date:

January 10, 2022

Version 6.3.2

Date:

January 04, 2022

Version 6.3.1

Date:

December 14, 2021

Version 6.3.0

Date:

November 29, 2021

Version 6.2.1

Date:

November 23, 2021

Version 6.2.0

Date:

November 16, 2021

Version 6.1.2

Date:

November 08, 2021

Version 6.1.1

Date:

November 02, 2021

Version 6.1.0

Date:

October 26, 2021

Version 6.0.0

Date:

October 13, 2021

This release includes the upgrade of some base dependencies:

  • Python version from 3.6 to 3.8

  • Ubuntu version from 18.04 LTS to 20.04 LTS

Starting from this release, all the Read the Docs code will be tested and QAed on these versions.

Version 5.25.1

Date:

October 11, 2021

Version 5.25.0

Date:

October 05, 2021

Version 5.24.0

Date:

September 28, 2021

Version 5.23.6

Date:

September 20, 2021

Version 5.23.5

Date:

September 14, 2021

  • @humitos: Organization: only mark artifacts cleaned as False if they are True (#8481)

  • @astrojuanlu: Fix link to version states documentation (#8475)

  • @stsewd: OAuth models: increase avatar_url lenght (#8472)

  • @pzhlkj6612: Docs: update the links to the dependency management content of setuptools docs (#8470)

  • @stsewd: Permissions: avoid using project.users, use proper permissions instead (#8458)

  • @humitos: Docker build images: update design doc (#8447)

  • @astrojuanlu: New Read the Docs tutorial, part I (#8428)

Version 5.23.4

Date:

September 07, 2021

Version 5.23.3

Date:

August 30, 2021

Version 5.23.2

Date:

August 24, 2021

Version 5.23.1

Date:

August 16, 2021

Version 5.23.0

Date:

August 09, 2021

Version 5.22.0

Date:

August 02, 2021

Version 5.21.0

Date:

July 27, 2021

Version 5.20.3

Date:

July 19, 2021

Version 5.20.2

Date:

July 13, 2021

Version 5.20.1

Date:

June 28, 2021

Version 5.20.0

Date:

June 22, 2021

Version 5.19.0

Warning

This release contains a security fix to our CSRF settings: https://github.com/readthedocs/readthedocs.org/security/advisories/GHSA-3v5m-qmm9-3c6c

Date:

June 15, 2021

Version 5.18.0

Date:

June 08, 2021

Version 5.17.0

Date:

May 24, 2021

Version 5.16.0

Date:

May 18, 2021

  • @stsewd: QuerySets: check for .is_superuser instead of has_perm (#8181)

  • @humitos: Build: use is_active method to know if the build should be skipped (#8179)

  • @humitos: APIv2: disable listing endpoints (#8178)

  • @stsewd: Project: use IntegerField for remote_repository from project form. (#8176)

  • @stsewd: Docs: remove some lies from cross referencing guide (#8173)

  • @stsewd: Docs: add space to bash code (#8171)

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 19 (#8170)

  • @stsewd: Querysets: include organizations in is_active check (#8163)

  • @stsewd: Querysets: remove private and for_project (#8158)

  • @davidfischer: Disable FLOC by introducing permissions policy header (#8145)

  • @stsewd: Build: allow to install packages with apt (#8065)

Version 5.15.0

Date:

May 10, 2021

  • @stsewd: Ads: don’t load script if a project is marked as ad_free (#8164)

  • @stsewd: Querysets: include organizations in is_active check (#8163)

  • @stsewd: Querysets: simplify project querysets (#8154)

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 18 (#8153)

  • @stsewd: Search: default to search on default version of subprojects (#8148)

  • @stsewd: Remove protected privacy level (#8146)

  • @stsewd: Embed: fix paths that start with / (#8139)

  • @humitos: Metrics: run metrics task every 30 minutes (#8138)

  • @humitos: web-celery: add logging for OOM debug on suspicious tasks (#8131)

  • @agjohnson: Fix a few style and grammar issues with SSO docs (#8109)

  • @stsewd: Embed: don’t fail while querying sections with bad id (#8084)

  • @stsewd: Design doc: allow to install packages using apt (#8060)

Version 5.14.3

Date:

April 26, 2021

Version 5.14.2

Date:

April 20, 2021

Version 5.14.1

Date:

April 13, 2021

  • @stsewd: OAuth: protection against deleted objects (#8081)

  • @cocobennett: Add page and page_size to server side api documentation (#8080)

  • @stsewd: Version warning banner: inject on role=”main” or main tag (#8079)

  • @stsewd: OAuth: avoid undefined var (#8078)

  • @stsewd: Conda: protect against None when appending core requirements (#8077)

  • @humitos: SSO: add small paragraph mentioning how to enable it on commercial (#8063)

  • @agjohnson: Add separate version create view and create view URL (#7595)

Version 5.14.0

Date:

April 06, 2021

This release includes a security update which was done in a private branch PR. See our security changelog for more details.

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 14 (#8071)

  • @astrojuanlu: Clarify ad-free conditions (#8064)

  • @humitos: SSO: add small paragraph mentioning how to enable it on commercial (#8063)

  • @stsewd: Build environment: allow to run commands with a custom user (#8058)

  • @humitos: Design document for new Docker images structure (#7566)

Version 5.13.0

Date:

March 30, 2021

Version 5.12.2

Date:

March 23, 2021

Version 5.12.1

Date:

March 16, 2021

Version 5.12.0

Date:

March 08, 2021

Version 5.11.0

Date:

March 02, 2021

Version 5.10.0

Date:

February 23, 2021

Version 5.9.0

Date:

February 16, 2021

Last Friday we migrated our site from Azure to AWS (read the blog post). This is the first release into our new AWS infra.

Version 5.8.5

Date:

January 18, 2021

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 03 (#7840)

  • @humitos: Speed up concurrent builds by limited to 5 hours ago (#7839)

  • @humitos: Match Redis version with production (#7838)

  • @saadmk11: Add Option to Enable External Builds Through Project Update API (#7834)

  • @stsewd: Docs: mention the version warning is for sphinx only (#7832)

  • @stsewd: Tests: make PRODUCTION_DOMAIN explicit (#7831)

  • @stsewd: Docs: make it easy to copy/pasta examples (#7829)

  • @stsewd: PR preview: pass PR and build urls to sphinx context (#7828)

  • @agjohnson: Hide design docs from documentation (#7826)

  • @stsewd: Footer: add cache tags (#7821)

  • @humitos: Log Stripe Resource fallback creation in Sentry (#7820)

  • @humitos: Register MetricsTask to send metrics to AWS CloudWatch (#7817)

  • @saadmk11: Add management command to Sync RemoteRepositories and RemoteOrganizations (#7803)

  • @stsewd: Mkdocs: default to “docs” for docs_dir (#7766)

Version 5.8.4

Date:

January 12, 2021

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 02 (#7818)

  • @stsewd: List SYNC_VERSIONS_USING_A_TASK flag in the admin (#7802)

  • @ericholscher: Update build concurrency numbers for Business (#7794)

  • @stsewd: Sphinx: use html_baseurl for setting the canonical URL (#7540)

Version 5.8.3

Date:

January 05, 2021

Version 5.8.2

Date:

December 21, 2020

Version 5.8.1

Date:

December 14, 2020

  • @humitos: Register ShutdownBuilder task (#7749)

  • @saadmk11: Use “path_with_namespace” for GitLab RemoteRepository full_name Field (#7746)

  • @stsewd: Features: remove USE_NEW_PIP_RESOLVER (#7745)

  • @stsewd: Version sync: exclude external versions when deleting (#7742)

  • @stsewd: Search: limit number of sections and domains to 10K (#7741)

  • @stsewd: Traffic analytics: don’t pass context if the feature isn’t enabled (#7740)

  • @stsewd: Analytics: move page views to its own endpoint (#7739)

  • @stsewd: FeatureQuerySet: make check for date inclusive (#7737)

  • @stsewd: Typo: date -> data (#7736)

  • @saadmk11: Use remote_id and vcs_provider Instead of full_name to Get RemoteRepository (#7734)

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 49 (#7730)

  • @saadmk11: Update parts of code that were using the old RemoteRepository model fields (#7728)

  • @stsewd: Builds: don’t delete them when a version is deleted (#7679)

  • @stsewd: Sync versions: create new versions in bulk (#7382)

  • @humitos: Use mamba under a feature flag to create conda environments (#6815)

Version 5.8.0

Date:

December 08, 2020

Version 5.7.0

Date:

December 01, 2020

Version 5.6.5

Date:

November 23, 2020

Version 5.6.4

Date:

November 16, 2020

Version 5.6.3

Date:

November 10, 2020

  • @pyup-bot: pyup: Scheduled weekly dependency update for week 43 (#7602)

Version 5.6.2

Date:

November 03, 2020

Version 5.6.1

Date:

October 26, 2020

Version 5.6.0

Date:

October 19, 2020

Version 5.5.3

Date:

October 13, 2020

Version 5.5.2

Date:

October 06, 2020

Version 5.5.1

Date:

September 28, 2020

Version 5.5.0

Date:

September 22, 2020

Version 5.4.3

Date:

September 15, 2020

Version 5.4.2

Date:

September 09, 2020

Version 5.4.1

Date:

September 01, 2020

Version 5.4.0

Date:

August 25, 2020

Version 5.3.0

Date:

August 18, 2020

Version 5.2.3

Date:

August 04, 2020

Version 5.2.2

Date:

July 29, 2020

Version 5.2.1

Date:

July 14, 2020

Version 5.2.0

Date:

July 07, 2020

Version 5.1.5

Date:

July 01, 2020

Version 5.1.4

Date:

June 23, 2020

Version 5.1.3

Date:

June 16, 2020

Version 5.1.2

Date:

June 09, 2020

Version 5.1.1

Date:

May 26, 2020

Version 5.1.0

Date:

May 19, 2020

This release includes one major new feature which is Pageview Analytics. This allows projects to see the pages in their docs that have been viewed in the past 30 days, giving them an idea of what pages to focus on when updating them.

This release also has a few small search improvements, doc updates, and other bugfixes as well.

Version 5.0.0

Date:

May 12, 2020

This release includes two large changes, one that is breaking and requires a major version upgrade:

  • We have removed our deprecated doc serving code that used core/views, core/symlinks, and builds/syncers (#6535). All doc serving should now be done via proxito. In production this has been the case for over a month, we have now removed the deprecated code from the codebase.

  • We did a large documentation refactor that should make things nicer to read and highlights more of our existing features. This is the first of a series of new documentation additions we have planned

  • @ericholscher: Fix the caching of featured projects (#7054)

  • @ericholscher: Docs: Refactor and simplify our docs (#7052)

  • @stsewd: Mention using ssh URLs when using private submodules (#7046)

  • @ericholscher: Show project slug in Version admin (#7042)

  • @stsewd: List apiv3 first (#7041)

  • @stsewd: Remove CELERY_ROUTER flag (#7040)

  • @stsewd: Search: remove unused taxonomy field (#7033)

  • @agjohnson: Use a high time limit for celery build task (#7029)

  • @ericholscher: Clean up build admin to make list display match search (#7028)

  • @stsewd: Task Router: check for None (#7027)

  • @stsewd: Implement repo_exists for all VCS backends (#7025)

  • @stsewd: Mkdocs: Index pages without anchors (#7024)

  • @agjohnson: Move docker limits back to setting (#7023)

  • @humitos: Fix typo (#7022)

  • @stsewd: Fix linter (#7021)

  • @ericholscher: Release 4.1.8 (#7020)

  • @ericholscher: Cleanup unresolver logging (#7019)

  • @stsewd: Document about next when using a secret link (#7015)

  • @stsewd: Remove unused field project.version_privacy_level (#7011)

  • @ericholscher: Add proxito headers to redirect responses (#7007)

  • @stsewd: Make hidden field not null (#6996)

  • @humitos: Show a list of packages installed on environment (#6992)

  • @eric-wieser: Ensure invoked Sphinx matches importable one (#6965)

  • @ericholscher: Add an unresolver similar to our resolver (#6944)

  • @KengoTODA: Replace “PROJECT” with project object (#6878)

  • @humitos: Remove code replaced by El Proxito and stateless servers (#6535)

Version 4.1.8

Date:

May 05, 2020

This release adds a few new features and bugfixes. The largest change is the addition of hidden versions, which allows docs to be built but not shown to users on the site. This will keep old links from breaking but not direct new users there.

We’ve also expanded the CDN support to make sure we’re passing headers on 3xx and 4xx responses. This will allow us to expand the timeout on our CDN.

We’ve also updated and added a good amount of documentation in this release, and we’re starting a larger refactor of our docs to help users understand the platform better.

Version 4.1.7

Date:

April 28, 2020

As of this release, most documentation on Read the Docs Community is now behind Cloudflare’s CDN. It should be much faster for people further from US East. Please report any issues you experience with stale cached documentation (especially CSS/JS).

Another change in this release related to how custom domains are handled. Custom domains will now redirect HTTP -> HTTPS if the Domain’s “HTTPS” flag is set. Also, the subdomain URL (eg. <project>.readthedocs.io/...) should redirect to the custom domain if the Domain’s “canonical” flag is set. These flags are configurable in your project dashboard under Admin > Domains.

Many of the other changes related to improvements for our infrastructure to allow us to have autoscaling build and web servers. There were bug fixes for projects using versions tied to annotated git tags and custom user redirects will now send query parameters.

Version 4.1.6

Date:

April 21, 2020

Version 4.1.5

Date:

April 15, 2020

Version 4.1.4

Date:

April 14, 2020

Version 4.1.3

Date:

April 07, 2020

Version 4.1.2

Date:

March 31, 2020

Version 4.1.1

Date:

March 24, 2020

Version 4.1.0

Date:

March 17, 2020

Version 4.0.3

Date:

March 10, 2020

Version 4.0.2

Date:

March 04, 2020

Version 4.0.1

Date:

March 03, 2020

Version 4.0.0

Date:

February 25, 2020

This release upgrades our codebase to run on Django 2.2. This is a breaking change, so we have released it as our 4th major version.

Version 3.12.0

Date:

February 18, 2020

This version has two major changes:

Version 3.11.6

Date:

February 04, 2020

Version 3.11.5

Date:

January 29, 2020

Version 3.11.4

Date:

January 28, 2020

Version 3.11.3

Date:

January 21, 2020

Version 3.11.2

Date:

January 08, 2020

Version 3.11.1

Date:

December 18, 2019

Version 3.11.0

Date:

December 03, 2019

Version 3.10.0

Date:

November 19, 2019

Version 3.9.0

Date:

November 12, 2019

Version 3.8.0

Date:

October 09, 2019

Version 3.7.5

Date:

September 26, 2019

Version 3.7.4

Date:

September 05, 2019

Version 3.7.3

Date:

August 27, 2019

Version 3.7.2

Date:

August 08, 2019

Version 3.7.1

Date:

August 07, 2019

Version 3.7.0

Date:

July 23, 2019

Version 3.6.1

Date:

July 17, 2019

Version 3.6.0

Date:

July 16, 2019

Version 3.5.3

Date:

June 19, 2019

Version 3.5.2

This is a quick hotfix to the previous version.

Date:

June 11, 2019

Version 3.5.1

This version contained a security fix for an open redirect issue. The problem has been fixed and deployed on readthedocs.org. For users who depend on the Read the Docs code line for a private instance of Read the Docs, you are encouraged to update to 3.5.1 as soon as possible.

Date:

June 11, 2019

Version 3.5.0

Date:

May 30, 2019

Version 3.4.2

Date:

April 22, 2019

Version 3.4.1

Date:

April 03, 2019

Version 3.4.0

Date:

March 18, 2019

Version 3.3.1

Date:

February 28, 2019

Version 3.3.0

Date:

February 27, 2019

Version 3.2.3

Date:

February 19, 2019

Version 3.2.2

Date:

February 13, 2019

Version 3.2.1

Date:

February 07, 2019

Version 3.2.0

Date:

February 06, 2019

Version 3.1.0

This version greatly improves our search capabilities, thanks to the Google Summer of Code. We’re hoping to have another version of search coming soon after this, but this is a large upgrade moving to the latest Elastic Search.

Date:

January 24, 2019

Version 3.0.0

Read the Docs now only supports Python 3.6+. This is for people running the software on their own servers, builds continue to work across all supported Python versions.

Date:

January 23, 2019

Version 2.8.5

Date:

January 15, 2019

Version 2.8.4

Date:

December 17, 2018

Version 2.8.3

Date:

December 05, 2018

Version 2.8.2

Date:

November 28, 2018

Version 2.8.1

Date:

November 06, 2018

Version 2.8.0

Date:

October 30, 2018

Major change is an upgrade to Django 1.11.

Version 2.7.2

Date:

October 23, 2018

Version 2.7.1

Date:

October 04, 2018

Version 2.7.0

Date:

September 29, 2018

Reverted, do not use

Version 2.6.6

Date:

September 25, 2018

Version 2.6.5

Date:

August 29, 2018

Version 2.6.4

Date:

August 29, 2018

Version 2.6.3

Date:

August 18, 2018

Release to Azure!

Version 2.6.2

Date:

August 14, 2018

Version 2.6.1

Date:

July 17, 2018

Version 2.6.0

Date:

July 16, 2018

Version 2.5.3

Date:

July 05, 2018

Version 2.5.2

Date:

June 18, 2018

Version 2.5.1

Date:

June 14, 2018

Version 2.5.0

Date:

June 06, 2018

Version 2.4.0

Date:

May 31, 2018

Version 2.3.14

Date:

May 30, 2018

Version 2.3.13

Date:

May 23, 2018

Version 2.3.12

Date:

May 21, 2018

Version 2.3.11

Date:

May 01, 2018

Version 2.3.10

Date:

April 24, 2018

Version 2.3.9

Date:

April 20, 2018

Version 2.3.8

Date:

April 20, 2018

  • @agjohnson: Give TaskStep class knowledge of the underlying task (#3983)

  • @humitos: Resolve domain when a project is a translation of itself (#3981)

Version 2.3.7

Date:

April 19, 2018

Version 2.3.6

Date:

April 05, 2018

Version 2.3.5

Date:

April 05, 2018

Version 2.3.4

  • Release for static assets

Version 2.3.3

Version 2.3.2

This version adds a hotfix branch that adds model validation to the repository URL to ensure strange URL patterns can’t be used.

Version 2.3.1

Version 2.3.0

Warning

Version 2.3.0 includes a security fix for project translations. See Release 2.3.0 for more information

Version 2.2.1

Version 2.2.1 is a bug fix release for the several issues found in production during the 2.2.0 release.

Version 2.2.0

Version 2.1.6

Version 2.1.5

Version 2.1.4

Version 2.1.3

date:

Dec 21, 2017