Changelog

Version 5.14.1

Date

April 13, 2021

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.

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.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

Version 5.8.4

Date

January 12, 2021

Version 5.8.3

Date

January 05, 2021

Version 5.8.2

Date

December 21, 2020

Version 5.8.1

Date

December 14, 2020

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

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.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:

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.7.5

Date

September 26, 2019

Version 3.7.4

Date

September 05, 2019

Version 3.7.2

Date

August 08, 2019

Version 3.7.0

Date

July 23, 2019

Version 3.6.1

Date

July 17, 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.4.2

Date

April 22, 2019

Version 3.3.1

Date

February 28, 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.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.4

Date

December 17, 2018

Version 2.8.3

Date

December 05, 2018

Version 2.8.2

Date

November 28, 2018

Version 2.8.0

Date

October 30, 2018

Major change is an upgrade to Django 1.11.

Version 2.7.0

Date

September 29, 2018

Reverted, do not use

Version 2.6.5

Date

August 29, 2018

Version 2.6.3

Date

August 18, 2018

Release to Azure!

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.0

Date

June 06, 2018

Version 2.4.0

Date

May 31, 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

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.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.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.1.5

Version 2.1.2

Version 2.1.1

Release information missing

Version 2.1.0

Previous releases

Starting with version 2.0, we will be incrementing the Read the Docs version based on semantic versioning principles, and will be automating the update of our changelog.

Below are some historical changes from when we have tried to add information here in the past

July 23, 2015

  • Django 1.8 Support Merged

Code Notes

Deployment Notes

After you have updated the code and installed the new dependencies, you need to run these commands on the server:

python manage.py migrate contenttypes
python manage.py migrate projects 0002 --fake
python manage.py migrate --fake-initial

Locally I had trouble in a test environment that pip did not update to the specified commit of tastypie. It might be required to use pip install -U -r requirements/deploy.txt during deployment.

Development Update Notes

The readthedocs developers need to execute these commands when switching to this branch (or when this got merged into master):

  • Before updating please make sure that all migrations are applied:

    python manage.py syncdb
    python manage.py migrate
    
  • Update the codebase: git pull

  • You need to update the requirements with pip install -r requirements.txt

  • Now you need to fake the initial migrations:

    python manage.py migrate contenttypes
    python manage.py migrate projects 0002 --fake
    python manage.py migrate --fake-initial