Changelog¶

Version 6.3.0¶

Date: November 29, 2021

@humitos: Tests: run tests with Python3.8 in CircleCI (#8718)
@stsewd: Test external serving for projects with -- in slug (#8716)
@humitos: requirements: add requests-oauthlib (#8712)
@astrojuanlu: Avoid future breakage of setup.py invokations (#8711)
@humitos: spam: fix admin filter (#8707)
@humitos: oauth: sync remote repositories fix (#8706)
@humitos: structlog: migrate application code to better logging (#8705)
@astrojuanlu: Add guide on Poetry (#8702)
@humitos: EmbedAPI: log success requests (#8689)

Version 6.2.1¶

Date: November 23, 2021

@agjohnson: Fix issue with PR build hostname parsing (#8700)
@ericholscher: Fix sharing titles (#8695)
@stsewd: Downgrade celery and friends (#8693)
@stsewd: Downgrade pyyaml (#8691)
@stsewd: Downgrade redis (#8690)
@humitos: Spam: make admin filters easier to understand (#8688)
@astrojuanlu: Clarify how to pin the Sphinx version (#8687)
@stsewd: Webhooks: fix link to docs (#8685)
@stsewd: Docs: update docs about search on subprojects (#8683)
@stsewd: Update common (#8681)
@pyup-bot: pyup: Scheduled weekly dependency update for week 46 (#8680)

Version 6.2.0¶

Date: November 16, 2021

@rokroskar: docs: update faq to mention apt for dependencies (#8676)
@stsewd: UserProfile: add time fields (#8675)
@stsewd: Admin: don’t use update to ban users (#8674)
@stsewd: UserProfile: add historical model (#8673)
@astrojuanlu: Add entry on Jupyter Book to the FAQ (#8669)
@stsewd: Proxito: add CDN-Cache-Control headers (#8667)
@humitos: Spam: sort admin filters and show threshold (#8666)
@humitos: Cleanup: remove old code (#8665)
@humitos: Spam: check for spam rules after user is banned (#8664)
@humitos: Spam: use 410 - Gone status code when blocked (#8661)
@astrojuanlu: Upgrade readthedocs-sphinx-search (#8660)
@agjohnson: Release 6.1.2 (#8657)
@astrojuanlu: Update requirements pinning (#8655)
@stsewd: Historical records: set the change reason explicitly on the instance (#8627)
@stsewd: Support for generic webhooks (#8522)

Version 6.1.2¶

Date: November 08, 2021

@astrojuanlu: Update requirements pinning (#8655)
@ericholscher: Fix GitHub permissions required (#8654)
@stsewd: Organizations: allow to add owners by email (#8651)
@pyup-bot: pyup: Scheduled weekly dependency update for week 44 (#8645)
@humitos: Spam: use thresholds to decide actions (#8632)
@astrojuanlu: Document generic webhooks (#8609)
@stsewd: Organizations: show audit logs (#8588)

Version 6.1.1¶

Date: November 02, 2021

@agjohnson: Drop beta from title of build config option (#8637)
@astrojuanlu: Remove mentions to old Python version specification (#8635)
@jugmac00: fix typos (#8630)
@Arthur-Milchior: Correct an example (#8628)
@davidfischer: Inherit theme template (#8626)
@astrojuanlu: Clarify duration of extra DNS records (#8625)
@astrojuanlu: Promote mamba more in the documentation, hide CONDA_USES_MAMBA (#8624)
@davidfischer: Floating ad placement for docs.readthedocs.io (#8621)
@stsewd: Audit: track downloads separately from page views (#8619)
@humitos: Celery: quick hotfix to task (#8617)

Version 6.1.0¶

Date: October 26, 2021

@astrojuanlu: Clarify docs (#8608)
@stsewd: Move more organization tests (#8606)
@astrojuanlu: New Read the Docs tutorial, part III (and finale?) (#8605)
@humitos: SSO: re-sync VCS accounts for SSO organization daily (#8601)
@humitos: Django Action: re-sync SSO organization’s users (#8600)
@pyup-bot: pyup: Scheduled weekly dependency update for week 42 (#8598)
@saadmk11: Don’t show the rebuild option on closed/merged Pull Request builds (#8590)
@carltongibson: Adjust Django intersphinx link to stable version. (#8589)
@humitos: Small fixes to asdf image upload script (#8587)
@astrojuanlu: Documentation names cleanup (#8586)
@stsewd: Fix docs (#8584)
@adamtheturtle: Fix typo “interpreters” (#8583)
@ericholscher: Small fixes to asdf image upload script (#8578)
@stsewd: Move organization views (#8577)
@humitos: EmbedAPIv3: docs for endpoint and guide updated (#8566)
@stsewd: GitLab integration: escape path (#8525)
@stsewd: Domain: allow to disable domain creation/update (#8020)

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.

@ericholscher: Release 5.25.1 (#8576)
@deepto98: Moved authenticated_classes definitions from API classes to AuthenticatedClassesMixin (#8562)
@humitos: Upgrade to Ubuntu 20.04 and Python 3.8 (#7421)

Version 5.25.1¶

Date: October 11, 2021

@astrojuanlu: Small fixes (#8564)
@deepto98: Moved authenticated_classes definitions from API classes to AuthenticatedClassesMixin (#8562)
@humitos: Build: update ca-certificates before cloning (#8559)
@humitos: Build: support Python 3.10.0 stable release (#8558)
@astrojuanlu: Document new build specification (#8547)
@astrojuanlu: Add checkbox to subscribe new users to newsletter (#8546)

Version 5.25.0¶

Date: October 05, 2021

@humitos: Docs: comment about how to add a new tool/version for builders (#8548)
@astrojuanlu: Add checkbox to subscribe new users to newsletter (#8546)
@humitos: Build: missing updates from review (#8544)
@humitos: EmbedAPI: allow CORS for /api/v3/embed/ (#8543)
@humitos: Script tools cache: fix environment variables (#8541)
@humitos: EmbedAPIv3: proxy URLs to be available under /_/ (#8540)
@humitos: Docker: use the correct image tag (#8539)
@humitos: Requirement: ping django-redis-cache to git tag (#8536)
@pyup-bot: pyup: Scheduled weekly dependency update for week 39 (#8531)
@astrojuanlu: Promote and restructure guides (#8528)
@stsewd: Analytics: allow to download all data (#8498)
@stsewd: HistoricalRecords: add additional fields (ip and browser) (#8490)

Version 5.24.0¶

Date: September 28, 2021

@humitos: EmbedAPIv3: updates after QA with sphinx-hoverxref (#8521)
@stsewd: Contact users: show progress (#8518)
@stsewd: Rename audit retention days setting (#8517)
@stsewd: Contact users: make notification sticky (#8516)
@stsewd: Contact users: report usernames instead of PK (#8515)
@stsewd: Audit: update admin (#8514)
@pyup-bot: pyup: Scheduled weekly dependency update for week 38 (#8510)
@stsewd: New config for new docker build images (#8478)
@stsewd: Audit: expose user security logs (#8477)
@humitos: Build: use new Docker images from design document (#8453)
@humitos: Embed APIv3: initial implementation (#8319)

Version 5.23.6¶

Date: September 20, 2021

@astrojuanlu: Change newsletter form (#8509)
@stsewd: Contact users: Allow to pass additional context to each email (#8507)
@astrojuanlu: Update onboarding (#8504)
@astrojuanlu: List default installed dependencies (#8503)
@astrojuanlu: Clarify that the development installation instructions are for Linux (#8494)
@stsewd: Audit: attach organization (#8491)
@astrojuanlu: Add virtual env instructions to local installation (#8488)
@humitos: Requirement: update orjson (#8487)
@humitos: Release 5.23.5 (#8486)
@astrojuanlu: New Read the Docs tutorial, part II (#8473)

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

@pzhlkj6612: Docs: update the links to the dependency management content of setuptools docs (#8470)
@nienn: Add custom team img styling (#8467)
@nienn: Docs: Change “right-click” to “click” (#8465)
@stsewd: Permissions: avoid using project.users, use proper permissions instead (#8458)
@stsewd: Add templatetag to filter by admin projects (#8456)
@stsewd: Support form: don’t allow to change the email (#8455)
@stsewd: Search: show only results from the current role_name being filtered (#8454)
@pyup-bot: pyup: Scheduled weekly dependency update for week 35 (#8451)
@stsewd: Update common (#8449)
@stsewd: API v3 (subprojects): filter by correct owner/organization (#8446)
@astrojuanlu: Rework Team page (#8441)
@mforbes: Added note about how to use Anaconda Project. (#8436)
@stsewd: Contact users: pass user and domain in the context (#8430)
@astrojuanlu: New Read the Docs tutorial, part I (#8428)
@stsewd: Footer: remove auth block (#8397)
@stsewd: API: fix subprojects creation when organizaions are enabled (#8393)
@stsewd: QuerySets: remove unused overrides (#8299)
@stsewd: QuerySets: filter permissions by organizations (#8298)

Version 5.23.3¶

Date: August 30, 2021

@stsewd: Update common (#8449)
@stsewd: Upgrade ES to 7.14.0 (#8448)
@humitos: Docs: typo in tutorial (#8442)
@astrojuanlu: Docs miscellaneous enhancements (#8440)
@astrojuanlu: New Read the Docs tutorial, part I (#8428)
@humitos: Track organization artifacts cleanup (#8418)

Version 5.23.2¶

Date: August 24, 2021

@astrojuanlu: Add MyST (Markdown) examples to “cross referencing with Sphinx” guide (#8437)
@saadmk11: Added Search and Filters for RemoteRepository and RemoteOrganization admin list page (#8431)
@agjohnson: Try out codeowners (#8429)
@humitos: Proxito: do not log response header for each custom domain request (#8427)
@cclauss: Fix undefined names (#8425)
@stsewd: Allow cookies from cross site requests to avoid problems with iframes (#8422)
@cclauss: Finish codespell – Concludes #8409 (#8421)
@cclauss: codespell CHANGELOG.rst (#8420)
@cclauss: codespell part 2 - Continues #8409 (#8419)
@ericholscher: Don’t filter on large items in the auditing sidebar. (#8417)
@astrojuanlu: Fix YAML extension (#8416)
@ericholscher: Release 5.23.1 (#8415)
@stsewd: Audit: attach project from the request if available (#8414)
@stsewd: Docs: update logout button image (#8413)
@pyup-bot: pyup: Scheduled weekly dependency update for week 33 (#8411)
@cclauss: Fix typos discovered by codespell in /docs (#8409)
@stsewd: Support: update contact information via Front webhook (#8406)
@stsewd: Docs: environment variables (#8390)
@stsewd: Allow users to remove themselves from a project (#8384)
@stsewd: Docs: document how to terminate a session (#8286)

Version 5.23.1¶

Date: August 16, 2021

@cclauss: Fix typos discovered by codespell in /docs (#8409)
@stsewd: Audit: use analytics’ get_client_ip (#8404)
@steko: Add documentation about webhooks for Gitea (#8402)
@ericholscher: Add CSP header to the domain options (#8388)
@stsewd: Cookies: set samesite: Lax by default (#8304)
@stsewd: Docs: document how to terminate a session (#8286)
@stsewd: Docs: update sharing (#8239)

Version 5.23.0¶

Date: August 09, 2021

@ericholscher: Only call analytics tracking of flyout when analytics are enabled (#8398)
@pyup-bot: pyup: Scheduled weekly dependency update for week 31 (#8385)
@stsewd: Audit: track user events (#8379)
@stsewd: Cookies: set samesite: Lax by default (#8304)
@stsewd: Docs: update sharing (#8239)
@DetectedStorm: Update LICENSE (#5125)

Version 5.22.0¶

Date: August 02, 2021

@pzhlkj6612: Docs: fix typo in versions.rst: -> need (#8383)
@ericholscher: Remove clickjacking middleware for proxito (#8378)
@stsewd: Config file: use string for python.version (#8372)
@humitos: Add support for Python3.10 on testing Docker image (#8328)
@stsewd: Analytics: don’t fail if the page was created in another request (#8310)

Version 5.21.0¶

Date: July 27, 2021

@stsewd: Fix migrations (#8373)
@ericholscher: Build out the MyST section of the getting started (#8371)
@stsewd: Fix tasks (#8370)
@astrojuanlu: Update common (#8368)
@astrojuanlu: Redirect users to appropriate support channels using template chooser (#8366)
@humitos: Proxito: return user-defined HTTP headers on custom domains (#8360)
@ericholscher: Release 5.20.3 (#8356)
@stsewd: Track model changes with django-simple-history (#8355)
@stsewd: SSO: move models (#8330)

Version 5.20.3¶

Date: July 19, 2021

@Nkarnaud: change vieweable to viewable on home page: issue#8346 (#8351)
@stsewd: Builds: don’t record git rev-parse command (#8348)
@stsewd: UI: allow to close notifications (#8345)
@stsewd: Use email from DEFAULT_FROM_EMAIL to contact users (#8344)
@stsewd: Downgrade taggit (#8342)
@stsewd: Dont mutate env vars outside the BuildEnv classes (#8340)
@stsewd: Guides: how to import a private project using an ssh key (#8336)

Version 5.20.2¶

Date: July 13, 2021

@humitos: psycopg2: pin to a compatible version with Django 2.2 (#8335)
@stsewd: Contact owners: use correct organization to filter (#8325)
@humitos: Design doc: fix render api endpoints (#8320)
@pyup-bot: pyup: Scheduled weekly dependency update for week 27 (#8317)
@mongolsteppe: Fixing minor error (#8313)
@stsewd: Build: remove after_vcs signal (#8311)
@The-Compiler: Add link to redirect docs (#8308)
@ericholscher: Add docs about setting up permissions for GH apps & orgs (#8305)
@stsewd: Schema: fix version type (#8303)
@stsewd: Slugify: don’t generate slugs with trailing - (#8302)
@ericholscher: Increase guide depth (#8300)
@humitos: autoscaling: remove app autoscaling tasks (#8297)
@humitos: PR build status: re-try up to 3 times if it fails for some reason (#8296)
@SethFalco: feat: add json schema (#8294)
@pyup-bot: pyup: Scheduled weekly dependency update for week 26 (#8293)
@stsewd: Organizations: validate that a correct slug is generated (#8292)
@stsewd: Footer: remove unused context vars (#8285)
@astrojuanlu: Add new guide about Jupyter in Sphinx (#8283)
@humitos: oauth webhook: check the Project has a RemoteRepository (#8282)
@stsewd: Allow to email users from a management command (#8243)
@humitos: Design doc: Embed APIv3 (#8222)
@astrojuanlu: Add proposal for new Sphinx and RTD tutorials (#8106)
@stsewd: Allow to change the privacy level of external versions (#7825)
@stsewd: Add tests for remove index files (#6381)

Version 5.20.1¶

Date: June 28, 2021

@stsewd: Organizations: validate that a correct slug is generated (#8292)
@stsewd: Footer: remove unused context vars (#8285)
@stsewd: Search: remove additional fields (#8284)
@humitos: oauth webhook: check the Project has a RemoteRepository (#8282)
@stsewd: Search: small improvements (#8276)
@stsewd: Search: ask for confirmation when running reindex_elasticsearch (#8275)
@saadmk11: Hit Elasticsearch only once for each search query through the APIv2 (#8228)
@humitos: Design doc: Embed APIv3 (#8222)
@stsewd: QuerySets: remove include_all (#8212)
@astrojuanlu: Add proposal for new Sphinx and RTD tutorials (#8106)
@stsewd: Add tests for remove index files (#6381)

Version 5.20.0¶

Date: June 22, 2021

@humitos: Migration: fix RemoteRepository - Project data migration (#8271)
@ericholscher: Release 5.19.0 (#8266)
@humitos: Sync RemoteRepository for external collaborators (#8265)
@stsewd: Git: don’t expand envvars in Gitpython (#8263)
@pyup-bot: pyup: Scheduled weekly dependency update for week 24 (#8262)
@stsewd: Builds: check for nonexistent object (#8261)
@humitos: Make Project -> ForeignKey -> RemoteRepository (#8259)
@agjohnson: Add basic security policy (#8254)
@stsewd: Search: remove workaround for subprojects (#8211)
@stsewd: Search: allow to filter by project slugs (#8149)

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

@stsewd: Builds: check for nonexistent object (#8261)
@ericholscher: Remove video from our Sphinx quickstart. (#8246)
@ericholscher: Remove “Markdown” from Mkdocs title (#8245)
@astrojuanlu: Make sustainability page more visible (#8244)
@stsewd: Builds: move send_build_status to builds/tasks.py (#8241)
@humitos: Add ability to rebuild a specific build (#8227)
@ericholscher: Don’t do any CORS checking on Embed API requests (#8226)
@stsewd: Footer: return well formed html (#8202)
@agjohnson: Add project/build filters (#8142)
@humitos: Sign Up: limit the providers allowed to sign up (#8062)
@stsewd: Search: use multi-fields for Wildcard queries (#7613)
@ericholscher: Add ability to rebuild a specific build (#6995)

Version 5.18.0¶

Date: June 08, 2021

@stsewd: Fix tests (#8240)
@ericholscher: Backport manual indexes (#8235)
@ericholscher: Clean up SSO docs (#8233)
@stsewd: Cache get_project (#8231)
@ericholscher: Don’t do any CORS checking on Embed API requests (#8226)
@saadmk11: Optimize Index time database query (#8224)
@stsewd: Proxito: check if attribute exists (#8220)
@agjohnson: Update gitter channel name (#8217)
@ericholscher: Remove IRC from our docs (#8216)
@stsewd: QuerySets: filter by admin/team (#8214)
@stsewd: QuerySets: remove unused detail parameter (#8213)
@pyup-bot: pyup: Scheduled weekly dependency update for week 21 (#8206)
@stsewd: QuerySets: refactor _add_user_repos (#8182)
@stsewd: Organizations: simplify querysets/managers (#8180)
@akien-mga: Docs: Add section about deleting downloadable content (#8162)
@stsewd: Search: refactor views (#8157)
@stsewd: Search: little optimization when saving search queries (#8132)
@akien-mga: Docs: Add some details to the User Defined Redirects (#7894)
@agjohnson: Add APIv3 version edit URL (#7594)
@saadmk11: Add List API Endpoint for RemoteRepository and RemoteOrganization (#7510)

Version 5.17.0¶

Date: May 24, 2021

@stsewd: Proxito: don’t require the middleware for proxied apis (#8203)
@stsewd: Builds: prevent code injection in cwd (#8198)
@ericholscher: Remove specific name from security page at user request (#8195)
@humitos: Docker: remove volumes= argument when creating the container (#8194)
@stsewd: Proxito: fix https and canonical redirects (#8193)
@stsewd: API v2: allow listing when using private repos (#8192)
@stsewd: Docker: set cwd explicitly (#8191)
@stsewd: API v2: allow to filter more endpoints (#8189)
@stsewd: Proxito: redirect to main project from subprojects (#8187)
@pyup-bot: pyup: Scheduled weekly dependency update for week 20 (#8186)
@agjohnson: Add DPA to legal docs in documentation (#8130)

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

@humitos: Metrics: run metrics task every 30 minutes (#8138)
@humitos: web-celery: add logging for OOM debug on suspicious tasks (#8131)
@stsewd: Celery router: check all n last builds for Conda (#8129)
@jonels-msft: Include aria-label in flyout search box (#8127)
@humitos: Logging: use %s to format the variable (#8125)
@stsewd: Build: improve list_packages_installed (#8122)
@stsewd: BuildCommand: don’t leak stacktrace to the user (#8121)
@stsewd: API (v2): use empty list in serializer’s exclude (#8120)
@astrojuanlu: Miscellaneous doc improvements (#8118)
@pyup-bot: pyup: Scheduled weekly dependency update for week 16 (#8117)
@agjohnson: Fix a few style and grammar issues with SSO docs (#8109)

Version 5.14.2¶

Date: April 20, 2021

@stsewd: OAuth: check if user exists (#8115)
@stsewd: Sync versions: don’t fetch/return all versions (#8114)
@astrojuanlu: Improve contributing docs, take 2 (#8113)
@stsewd: ImportedFile: remove md5 field (#8111)
@stsewd: Config file: improve docs and help text (#8110)
@stsewd: Docs: add warning about design docs (#8104)
@Harmon758: Docs: fix typo in config-file/v2.rst (#8102)
@cocobennett: Improve documentation on contributing to documentation (#8082)

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

@stsewd: Test proxied embed API (#8051)
@stsewd: Feature flag: remove EXTERNAL_BUILD (#8050)
@stsewd: Sync versions: always use a task (#8049)
@stsewd: Versions: don’t create versions in bulk (#8046)
@stsewd: Embed: add cache tags (#8045)
@ericholscher: Fix proxito slash redirect for leading slash (#8044)
@pyup-bot: pyup: Scheduled weekly dependency update for week 12 (#8038)
@humitos: Docs: cleanup of old/deprecated documents (#7994)
@flying-sheep: Add publicly visible env vars (#7891)
@stsewd: Remove broadcast function (#7044)

Version 5.12.2¶

Date: March 23, 2021

@humitos: AWS homepage link (#8037)
@hukkinj1: Fix a typo in the docs (#8035)
@stsewd: Clean some feature flags (#8034)
@ericholscher: Standardize footerjs code (#8032)
@stsewd: Docs: remove pdf format in MkdDocs example (#8030)
@stsewd: Search: don’t leak data for projects with this feature disabled (#8029)
@ericholscher: Canonicalize all proxito slashes (#8028)
@ericholscher: Make pageviews analytics show top 25 pages (#8027)
@ericholscher: Add CSV header data for search analytics (#8026)
@stsewd: HTMLFile: make md5 field nullable (#8025)
@humitos: Use RemoteRepository relation to match already imported projects (#8024)
@stsewd: Badge: exclude duplicated builds (#8023)
@stsewd: Intersphinx: declare user agent (#8022)
@stsewd: Builds: restart build commands before a new build (#7999)
@saadmk11: Remote Repository and Remote Organization Normalization (#7949)
@stsewd: Build: don’t track changed files (#7874)

Version 5.12.1¶

Date: March 16, 2021

@pyup-bot: pyup: Scheduled weekly dependency update for week 11 (#8019)
@stsewd: Embed: Allow to override embed view for proxied use (#8018)
@humitos: RemoteRepository: Improvements to sync_vcs_data.py script (#8017)
@humitos: Stripe checkout: handle events (#8016)
@humitos: Remove contrib/ directory (#8014)
@stsewd: Dockerfile: install lsb_release (#8010)
@davidfischer: Fix AWS image so it looks sharp (#8009)
@stsewd: Update common (#8008)
@stsewd: Update Sphinx (#8007)
@2Fake: fix small typo (#8005)
@stsewd: Embed: validate query arguments (#8003)
@humitos: Stripe Checkout: handle duplicated wehbook (#8002)
@saadmk11: Add __str__ to RemoteRepositoryRelation and RemoteOrganizationRelation and Use raw_id_fields in Admin (#8001)
@saadmk11: Remove duplicate results from RemoteOrganization API (#8000)
@humitos: Typo fixed on checkout.js (#7998)
@ericholscher: Make SupportView login_required (#7997)
@ericholscher: Release 5.12.0 (#7996)
@pyup-bot: pyup: Scheduled weekly dependency update for week 10 (#7995)
@saadmk11: Remove json field from RemoteRepositoryRelation and RemoteOrganizationRelation model (#7993)
@humitos: Use independent Docker image to build assets (#7992)
@Pradhvan: Fixes typo in getting-started-with-sphinx: (#7991)
@humitos: Allow donate app to use Stripe Checkout for one-time donations (#7983)
@ericholscher: Add proxito healthcheck (#7948)
@Pradhvan: Docs: Adds Myst to the getting started with sphinx (#7938)
@humitos: Use Stripe Checkout for Gold Users (#7889)
@stsewd: Docs: guide about reproducible builds (#7888)

Version 5.12.0¶

Date: March 08, 2021

@pyup-bot: pyup: Scheduled weekly dependency update for week 10 (#7995)
@saadmk11: Remove json field from RemoteRepositoryRelation and RemoteOrganizationRelation model (#7993)
@humitos: Use independent Docker image to build assets (#7992)
@Pradhvan: Fixes typo in getting-started-with-sphinx: (#7991)
@stsewd: Search: use doctype from indexed pages instead of the db (#7984)
@humitos: Allow donate app to use Stripe Checkout for one-time donations (#7983)
@humitos: Update development/standards guide (#7981)
@stsewd: Docs: update expand_tabs to work with the latest version of sphinx-tabs (#7979)
@ericholscher: Fix build routing (#7978)
@stsewd: Builds: register tasks to delete inactive external versions (#7975)
@stsewd: Embed: fix join (#7974)
@stsewd: Embed: change proxied urls (#7973)
@ericholscher: refactor footer, add jobs & status page (#7970)
@stsewd: Sphinx domain: remove API (#7969)
@humitos: Upgrade postgres-client to v12 in Docker image (#7967)
@saadmk11: Add management command to Load Project and RemoteRepository Relationship from JSON file (#7966)
@astrojuanlu: Update guide on conda support (#7965)
@stsewd: Embed: add more tests (#7962)
@humitos: Lower rank of development/install.html (#7960)
@stsewd: Embed: refactor view (#7955)
@stsewd: Search: make –queue required for management command (#7952)
@ericholscher: Add proxito healthcheck (#7948)
@Pradhvan: Docs: Adds Myst to the getting started with sphinx (#7938)
@ericholscher: Add a support form to the website (#7929)
@humitos: Use Stripe Checkout for Gold Users (#7889)
@stsewd: Docs: guide about reproducible builds (#7888)
@stsewd: Docs: update links from build images (#7886)
@stsewd: Install latest mkdocs by default as we do with sphinx (#7869)
@stsewd: Docs: document analytics (#7857)
@stsewd: Remove some feature flags (#7846)
@stsewd: Update requirements/deploy.txt (#7843)
@humitos: Implementation of APIv3 (#4863)

Version 5.11.0¶

Date: March 02, 2021

@saadmk11: Add management command to Load Project and RemoteRepository Relationship from JSON file (#7966)
@humitos: Lower rank of development/install.html (#7960)
@saadmk11: Add Management Command to Dump Project and RemoteRepository Relationship in JSON format (#7957)
@davidfischer: Enable the cached template loader (#7953)
@stsewd: Update common to master (#7951)
@stsewd: Embed: refactor tests (#7947)
@stsewd: Downgrade jedi (#7946)
@FatGrizzly: Added warnings for previous gitbook users (#7945)
@stsewd: Move embed app (#7943)
@ericholscher: Change our sponsored hosting from Azure -> AWS. (#7940)
@Pradhvan: Docs: Adds Myst to the getting started with sphinx (#7938)
@ericholscher: Add a support form to the website (#7929)
@stsewd: Drop six (#7890)
@fabianmp: Allow to use a different url for intersphinx object file download (#7807)

Version 5.10.0¶

Date: February 23, 2021

@pyup-bot: pyup: Scheduled weekly dependency update for week 08 (#7941)
@PawelBorkar: Update license (#7934)
@humitos: Route external versions to the queue were default version was built (#7933)
@humitos: Pin jedi dependency to avoid breaking ipython (#7932)
@humitos: Use admin user for SLUMBER API on local environment (#7925)
@stsewd: Search: add cache tags (#7922)
@humitos: Use S3 from community (#7920)
@stsewd: Use only one variant of the config file (#7918)
@pyup-bot: pyup: Scheduled weekly dependency update for week 07 (#7913)
@humitos: Router PRs builds to last queue where a build was executed (#7912)
@stsewd: Search: improve re-index management command (#7904)
@stsewd: Search: link to main project in subproject results (#7880)
@humitos: Upgrade Celery and friends to latest versions (#7786)

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.

@humitos: Router PRs builds to last queue where a build was executed (#7912)
@humitos: Update common/ submodule (#7910)
@humitos: Upgrade Redis version to match production (#7909)
@davidfischer: Make storage classes into module level vars (#7908)
@csdev: fix typo (#7902)
@humitos: Match Redis version from AWS producion (#7897)
@pyup-bot: pyup: Scheduled weekly dependency update for week 06 (#7896)
@nedbat: Doc fix: two endpoints had ‘pip’ for the project_slug (#7895)
@stsewd: Set storage for BuildCommand and BuildEnvironment as private (#7893)
@pyup-bot: pyup: Scheduled weekly dependency update for week 05 (#7887)
@humitos: Add support for Python 3.9 on “testing” Docker image (#7885)
@stsewd: Add version_changed signal (#7878)
@stsewd: Search: don’t index permalinks (#7876)
@stsewd: Update common (#7873)
@pyup-bot: pyup: Scheduled weekly dependency update for week 04 (#7867)
@humitos: Log Stripe errors when trying to delete customer/subscription (#7853)
@humitos: Save builder when the build is concurrency limited (#7851)
@stsewd: Remove some feature flags (#7846)
@stsewd: Fix conf.py for external versions (#7845)
@humitos: Metric tasks for community (#7841)
@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)
@agjohnson: Hide design docs from documentation (#7826)
@stsewd: Update docs about preview from pull/merge requests (#7823)
@humitos: Register MetricsTask to send metrics to AWS CloudWatch (#7817)
@humitos: Use S3 (MinIO emulator) as storage backend (#7812)
@zachdeibert: Cloudflare to Cloudflare CNAME Records (#7801)
@humitos: Documentation for /organizations/ endpoint in commercial (#7800)
@stsewd: Privacy Levels: migrate protected projects to private (#7608)
@pawamoy: Don’t lose python/name tags values in mkdocs.yml (#7507)
@stsewd: Install latest version of setuptools (#7290)
@humitos: Implementation of APIv3 (#4863)

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

@humitos: Change query on send_build_status task for compatibility with .com (#7797)
@ericholscher: Update build concurrency numbers for Business (#7794)
@pyup-bot: pyup: Scheduled weekly dependency update for week 01 (#7793)
@timgates42: docs: fix simple typo, -> translations (#7781)
@ericholscher: Release 5.8.2 (#7776)
@humitos: Use Python3.7 on conda base environment when using mamba (#7773)
@stsewd: Remove domain verify signal and task (#7763)
@stsewd: Import page: fix wizard form (#7702)
@ericholscher: Migrate sync_versions from an API call to a task (#7548)
@humitos: Design document for RemoteRepository DB normalization (#7169)

Version 5.8.2¶

Date: December 21, 2020

@humitos: Use Python3.7 on conda base environment when using mamba (#7773)
@stsewd: Remove domain verify signal and task (#7763)
@humitos: Register StopBuilder task to be executed by builders (#7759)
@stsewd: Footer: remove absolute_uri (#7758)
@stsewd: Search: use alias to link to search results of subprojects (#7757)
@stsewd: Footer: remove jsonp call (#7756)
@humitos: Register AutoscaleBuildersTask (#7755)
@saadmk11: Set The Right Permissions on GitLab OAuth RemoteRepository (#7753)
@stsewd: Use lru_cache for caching methods (#7751)
@fabianmp: Allow to add additional binds to Docker build container (#7684)

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

@stsewd: Update common (#7731)
@stsewd: Bitbucket: mainbranch can be None (#7725)
@stsewd: Search: use with_positions_offsets term vector for some fields (#7724)
@stsewd: Search: filter only active and built versions from subprojects (#7723)
@stsewd: Extra features: allow to display them conditionally (#7715)
@humitos: Define pre/post_collectstatic signals and send them (#7701)
@davidfischer: Support the new Google analytics gtag.js (#7691)
@stsewd: HTMLFile: remove slug field (#7680)
@stsewd: External versions: delete after 3 months of being merged/closed (#7678)
@stsewd: Automation Rules: keep history of recent matches (#7658)
@stsewd: Search: update to ES 7.x (#7582)

Version 5.7.0¶

Date: December 01, 2020

@davidfischer: Ensure there is space for sidebar ads (#7716)
@humitos: Install six as core requirement for builds (#7710)
@stsewd: Features: increase feature_id max_length (#7698)
@ericholscher: Release 5.6.1 (#7695)
@stsewd: Tests: mock trigger_build (#7681)
@stsewd: Sync versions: use stable version instead of querying all versions (#7380)

Version 5.6.5¶

Date: November 23, 2020

@stsewd: Tests: mock trigger_build (#7681)
@stsewd: Tests: mock update_docs_task to speed up tests (#7677)
@stsewd: Versions: add timestamp fields (#7676)
@stsewd: Tests: create an organization when running in .com (#7673)
@davidfischer: Speed up the tag index page (#7671)
@davidfischer: Fix for out of order script loading (#7670)
@davidfischer: Set ad configuration values if using explicit placement (#7669)
@pyup-bot: pyup: Scheduled weekly dependency update for week 46 (#7668)
@stsewd: Tests: mock trigger build to speed up tests (#7661)
@stsewd: Remote repository: save and set default_branch (#7646)
@stsewd: Search: exclude some fields from source results (#7640)
@stsewd: Search: allow to search on different versions of subprojects (#7634)
@stsewd: Search: refactor api view (#7633)
@saadmk11: Add Initial Modeling with Through Model and Data Migration for RemoteRepository Model (#7536)
@stsewd: ImportedFile: remove slug 1/2 (#7228)
@humitos: Changes required for APIv3 in corporate (#6489)

Version 5.6.4¶

Date: November 16, 2020

@davidfischer: Fix for out of order script loading (#7670)
@davidfischer: Set ad configuration values if using explicit placement (#7669)
@pyup-bot: pyup: Scheduled weekly dependency update for week 46 (#7668)
@pyup-bot: pyup: Scheduled weekly dependency update for week 45 (#7655)
@stsewd: Automation rules: add delete version action (#7644)
@stsewd: Search: exclude some fields from source results (#7640)
@saadmk11: Add Initial Modeling with Through Model and Data Migration for RemoteRepository Model (#7536)
@humitos: Changes required for APIv3 in corporate (#6489)

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

@humitos: Check only for override settings (part 2) (#7630)
@humitos: Check only override settings (#7628)
@davidfischer: Display sidebar ad when scrolled (#7621)
@humitos: Reserve 1Gb for Application Memory (#7618)
@humitos: Catch requests.exceptions.ReadTimeout when removing container (#7617)
@humitos: Allow search and filter in Django Admin for Message model (#7615)
@stsewd: CI: use badge from circleci (#7614)
@stsewd: Search: respect feature flag in dashboard search (#7611)
@ericholscher: Release 5.6.1 (#7604)
@stsewd: CI: use circleci (#7603)

Version 5.6.1¶

Date: October 26, 2020

@agjohnson: Bump common to include docker task changes (#7597)
@agjohnson: Default to sphinx theme 0.5.0 when defaulting to latest sphinx (#7596)
@humitos: Use correct Cache-Tag (CDN) and X-RTD-Project header on subprojects (#7593)
@davidfischer: Ads JS hotfix (#7586)
@agjohnson: Add remoterepo query param (#7580)
@agjohnson: Undeprecate APIv2 in docs (#7579)
@agjohnson: Add settings and docker configuration for working with new theme (#7578)
@stsewd: Search: exclude chagelog from results (#7570)
@stsewd: Search: better results for single terms (#7569)
@stsewd: Search: refactor query objects (#7568)
@humitos: Add our readthedocs_processor data to our notifications (#7565)
@stsewd: Update ES to 6.8.12 (#7559)
@stsewd: Builds: always install latest version of our sphinx extension (#7542)
@stsewd: Bring back project privacy level (#7525)
@ericholscher: Add future default true to Feature flags (#7524)
@stsewd: Add feature flag to not install the latest version of pip (#7522)
@davidfischer: No longer proxy RTD ads through RTD servers (#7506)
@stsewd: Subprojects: fix form (#7491)
@AvdN: correct inconsistent indentation of YAML (#7459)

Version 5.6.0¶

Date: October 19, 2020

@stsewd: Search: exclude chagelog from results (#7570)
@stsewd: Docs: show example of a requirements.txt file (#7563)
@stsewd: Update ES to 6.8.12 (#7559)
@pyup-bot: pyup: Scheduled weekly dependency update for week 40 (#7537)
@ericholscher: Add future default true to Feature flags (#7524)
@davidfischer: No longer proxy RTD ads through RTD servers (#7506)
@davidfischer: Allow projects to opt-out of analytics (#7175)

Version 5.5.3¶

Date: October 13, 2020

@ericholscher: Add a reference to the Import guide at the start of Getting started (#7547)
@kuzmoyev: Include month-ago day to traffic data (#7545)
@stsewd: Downloads: fix translation of a subproject (#7541)
@stsewd: Domains: more robust form (#7523)
@stsewd: Revert “Revert ES: update dependencies” (#7439)
@stsewd: Search: remove old endpoint (#7414)

Version 5.5.2¶

Date: October 06, 2020

@stsewd: Domain: show created/modified date in admin (#7517)
@stsewd: Tests: fix eslint (#7516)
@ericholscher: Revert “New docker image for builders: 8.0” (#7514)
@srijan-deepsource: Fix some code quality issues (#7494)

Version 5.5.1¶

Date: September 28, 2020

@stsewd: Domain: fix form (#7502)
@stsewd: Builders: little refactor (#7500)
@ericholscher: Add proper div names on our ad placements (#7493)
@saadmk11: APIv3 Version list slug filter added (#7372)
@humitos: Use “-j auto” on sphinx-build command to build in parallel (#7128)

Version 5.5.0¶

Date: September 22, 2020

@stsewd: Don’t install pygments (#7490)
@humitos: Limit concurrency per-organization (#7489)
@pyup-bot: pyup: Scheduled weekly dependency update for week 37 (#7482)
@humitos: Use permissions (project and group) for RemoteRepository.admin on GitLab (#7479)

Version 5.4.3¶

Date: September 15, 2020

@stsewd: Domain: inherit from TimeStampedModel (#7476)
@stsewd: Truncate output at the start for large commands (#7473)
@stsewd: Add dependency explicitly (dateutil) (#7415)
@stsewd: Domains: add ssl_status field (#7398)
@stsewd: Search: allow ignoring files from indexing (#7308)
@stsewd: Search: SSS integration guide (#7232)

Version 5.4.2¶

Date: September 09, 2020

@humitos: Show “Connected Services” form errors to the user (#7469)
@humitos: Allow to extend OrganizationTeamBasicForm from -corporate (#7467)
@pyup-bot: pyup: Scheduled weekly dependency update for week 36 (#7465)
@AvdN: correct invalid YAML (#7458)
@stsewd: Remote repository: filter by account before deleting (#7454)
@humitos: Truncate the beginning of the commands’ output (#7449)
@davidfischer: Update links to advertising (#7443)
@stsewd: Revert “Don’t retry on POST” (#7442)
@stsewd: Organizations: move signals (#7441)
@stsewd: Organizations: move forms (#7438)
@humitos: Grab the correct name of RemoteOrganization to use in the query (#7430)
@stsewd: Revert “ES: update dependencies” (#7429)
@pyup-bot: pyup: Scheduled weekly dependency update for week 35 (#7423)
@humitos: Mark a build as DUPLICATED (same version) only it’s close in time (#7420)

Version 5.4.1¶

Date: September 01, 2020

@stsewd: Docs: update readthedcos-sphinx-search ext (#7427)
@humitos: Upgrade Django to 2.2.16 (#7426)
@bmorrison4: Fix typo in docs/guides/adding-custom-css.rst (#7424)
@stsewd: Test: set privacy level explicitly (#7422)
@stsewd: Pip: test new resolver (#7412)
@stsewd: Update common (#7411)
@stsewd: Release 5.4.0 (#7410)
@stsewd: Docker: install requirements from local changes (#7409)
@stsewd: ES: update dependencies (#7408)
@pyup-bot: pyup: Scheduled weekly dependency update for week 34 (#7406)
@stsewd: API client: don’t retry on POST (#7383)
@saadmk11: build_url added to all API v3 build endpoints (#7373)
@stsewd: Guide: deprecating content (#7333)
@humitos: Auto-join email users field for Team model (#7328)
@stsewd: Guide: Cross-referencing with Sphinx (#7326)
@humitos: Sync RemoteRepository and RemoteOrganization in all VCS providers (#7310)
@stsewd: Page views: use origin URL instead of page name (#7293)

Version 5.4.0¶

Date: August 25, 2020

@stsewd: ES: match version used in production (#7407)
@davidfischer: Advertising docs tweaks (#7400)
@stsewd: Docs: update readthedocs-sphinx-search (#7399)
@keewis: document installing into a environment with pinned dependencies (#7397)
@pyup-bot: pyup: Scheduled weekly dependency update for week 32 (#7377)
@stsewd: Builds: store build commands in storage (#7356)
@stsewd: Guide: Cross-referencing with Sphinx (#7326)

Version 5.3.0¶

Date: August 18, 2020

@humitos: Remove the comma added in logs that breaks grep parsing (#7393)
@stsewd: GitLab webhook: don’t fail on invalid payload (#7391)
@stsewd: Task router: improve logging (#7389)
@stsewd: External providers: better logging for GitLab (#7385)
@stsewd: Task router: small changes (#7379)
@stsewd: Search: return relatives URLS (#7376)
@stsewd: Sync versions: little optimization when deleting versions (#7367)
@agjohnson: Add feature flag to just skip the sync version task entirely (#7366)
@agjohnson: Convert zip to list for templates (#7359)
@stsewd: Search: implement stable API (#7255)
@stsewd: Search: improve parser (#7233)

Version 5.2.3¶

Date: August 04, 2020

@davidfischer: Add a middleware for referrer policy (#7346)
@stsewd: Footer: don’t show the version warning for external version (#7340)
@ericholscher: Lower rank for custom install docs. (#7339)
@benjaoming: Argument list for “python -m virtualenv” without empty strings (#7330)
@stsewd: Docs: fix some links (#7317)
@stsewd: Docs: little improvements on getting start docs (#7316)
@stsewd: Search: migrate null ranks to zero (#7274)
@stsewd: Docs: make it more clear search on subprojects (#7272)

Version 5.2.2¶

Date: July 29, 2020

@agjohnson: Reduce robots.txt cache TTL (#7334)
@davidfischer: Use the privacy embed for YouTube (#7320)
@DougCal: re-worded text on top of “Import a Repository” (#7318)
@stsewd: Docs: make it clear the config file options are per version (#7314)
@humitos: Feature to disable auto-generated index.md/README.rst files (#7305)
@stsewd: Sphinx: always exclude the build directory (#7303)
@humitos: Enable SessionAuthentication on APIv3 endpoints (#7295)
@humitos: Allow to extend TeamManager (#7294)
@pyup-bot: pyup: Scheduled weekly dependency update for week 28 (#7287)
@humitos: Make “homepage” optional when updating a project (#7286)
@humitos: Allow users to set hidden on versions via APIv3 (#7285)
@humitos: DONT_INSTALL_DOCUTILS feature flag (#7276)
@humitos: Documentation for Single Sign-On feature on commercial (#7212)

Version 5.2.1¶

Date: July 14, 2020

@davidfischer: Fix a case where “tags” is interpreted as a project slug (#7284)
@stsewd: Dashboard: little optimization (#7281)
@stsewd: Automation rules: privacy levels (#7278)
@stsewd: Templates: optimize permissions check (#7277)
@agjohnson: Fix versions (#7271)
@stsewd: Tweak priority a little more (#7270)
@stsewd: Don’t default on the migration (#7269)
@saadmk11: Automation rule to make versions hidden added (#7265)
@humitos: Add is_member template filter (#7264)
@stsewd: Docs: set ranking for some pages (#7257)
@stsewd: Sphinx: add –keep-going when fail_on_warning is true (#7251)
@saadmk11: Don’t allow Domain name matching production domain to be created (#7244)
@humitos: Documentation for Single Sign-On feature on commercial (#7212)

Version 5.2.0¶

Date: July 07, 2020

@saadmk11: Version docs Typo fix (#7266)
@stsewd: CI: fix linter (#7261)
@GioviQ: Update manage-translations.rst (#7260)
@ericholscher: Add additional logging for sync_repository task (#7254)
@stsewd: Search: custom search page ranking (#7237)

Version 5.1.5¶

Date: July 01, 2020

@choldgraf: cross-linking build limitations for pr builds (#7248)
@humitos: Allow to extend Import Project page from corporate (#7234)
@humitos: Make RemoteRepository.full_name db_index=True (#7231)
@stsewd: Search: tweak fuzziness (#7225)
@ericholscher: Re-add the rst filter that got removed (#7223)

Version 5.1.4¶

Date: June 23, 2020

@stsewd: Search: index from html files for mkdocs projects (#7208)
@stsewd: Search: recursively parse sections (#7207)
@stsewd: Search: more general parser for html (#7204)
@humitos: Use total_memory to calculate “time” Docker limit (#7203)
@davidfischer: Feature flag for using latest Sphinx (#7201)
@ericholscher: Mention that we don’t index search in PR builds (#7199)
@davidfischer: Add a feature flag to use latest RTD Sphinx ext (#7198)
@ericholscher: Release 5.1.3 (#7197)
@stsewd: Search: improve results for simple queries (#7194)
@stsewd: Search: refactor json parser (#7184)
@stsewd: Remove unused dep (#7147)
@agjohnson: Use theme release 0.5.0rc1 for docs (#7037)
@humitos: Skip promoting new stable if current stable is not machine=True (#6695)

Version 5.1.3¶

Date: June 16, 2020

@davidfischer: Fix the project migration conflict (#7196)
@stsewd: Search: fix pagination (#7195)
@ericholscher: Document the fact that PR builds are now enabled on .org (#7187)
@stsewd: Project: make description shorter (#7186)
@stsewd: Migrate private versions (#7181)
@ericholscher: Update sharing examples (#7179)
@davidfischer: Allow projects to opt-out of analytics (#7175)
@stsewd: Docs: install readthedocs-sphinx-search from pypi (#7174)
@humitos: Rename API endpoint call (#7173)
@ericholscher: Reduce logging in proxito middleware so it isn’t in Sentry (#7172)
@ericholscher: Release 5.1.2 (#7171)
@humitos: Use CharField.choices for Build.status_code (#7166)
@davidfischer: Store pageviews via signals, not tasks (#7106)
@stsewd: Move organizations models (#6776)

Version 5.1.2¶

Date: June 09, 2020

@humitos: Use CharField.choices for Build.status_code (#7166)
@humitos: Install argh for Docker environment (#7164)
@ericholscher: Reindex search on the reindex queue (#7161)
@stsewd: Project search: Show original description when there isn’t highlight (#7160)
@stsewd: Search: highlight results from projects (#7158)
@ericholscher: Fix custom URLConf redirects (#7155)
@ericholscher: Allow blank=True for URLConf (#7153)
@stsewd: Fix flaky test (#7148)
@stsewd: Search: Make total_results not null (#7145)
@stsewd: Project: make external_builds_enabled not null (#7144)
@saadmk11: Do not Pre-populate username field for account delete (#7143)
@davidfischer: Add feature flag to use the stock Sphinx builders (#7141)
@ericholscher: Move changes_files to before search indexing (#7138)
@stsewd: Proxito middleware: reset to original urlconf after request (#7137)
@stsewd: Search: don’t index permalinks (#7134)
@ericholscher: Revert “Merge pull request #7101 from readthedocs/show-last-total” (#7133)
@ericholscher: Release 5.1.1 (#7129)
@humitos: Use “-j auto” on sphinx-build command to build in parallel (#7128)
@humitos: De-duplicate builds (#7123)
@stsewd: Search: refactor API to not emulate a Django queryset (#7114)
@davidfischer: Store pageviews via signals, not tasks (#7106)
@stsewd: Search: don’t index line numbers from code blocks (#7104)
@humitos: Document Embed APIv2 endpoint (#7095)
@ericholscher: Add a project-level configuration for PR builds (#7090)
@stsewd: Remove usage of project.privacy_level (#7013)
@pyup-bot: pyup: Scheduled weekly dependency update for week 18 (#7012)
@stsewd: Allow to enable server side search for MkDocs (#6986)
@stsewd: Pass the NO_COLOR env var to builder (#6981)
@humitos: Limit concurrency in translations (#6969)
@ericholscher: Add ability for users to set their own URLConf (#6963)

Version 5.1.1¶

Date: May 26, 2020

@stsewd: Search: show total_results from last query (#7101)
@humitos: Add a tip in EmbedAPI to use Sphinx reference in section (#7099)
@ericholscher: Release 5.1.0 (#7098)
@ericholscher: Add a setting for storing pageviews (#7097)
@humitos: Document Embed APIv2 endpoint (#7095)
@stsewd: Footer: Check for mkdocs doctype too (#7094)
@ericholscher: Fix the unresolver not working properly with root paths (#7093)
@ericholscher: Add a project-level configuration for PR builds (#7090)
@santos22: Fix tests ahead of django-dynamic-fixture update (#7073)
@ericholscher: Add ability for users to set their own URLConf (#6963)
@dojutsu-user: Store Pageviews in DB (#6121)
@humitos: GitLab Integration (#3327)

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.

@ericholscher: Add a setting for storing pageviews (#7097)
@stsewd: Footer: Check for mkdocs doctype too (#7094)
@ericholscher: Fix the unresolver not working properly with root paths (#7093)
@stsewd: Privacy levels: migrate protected versions (#7092)
@humitos: Guide for Embed API (#7089)
@davidfischer: Document HSTS support (#7083)
@stsewd: Search: record queries with 0 results (#7081)
@stsewd: Search: track total results (#7080)
@humitos: Proxy embed URL (#7079)
@stsewd: Search: Little refactor (#7076)
@davidfischer: Canonical/HTTPS redirect fix (#7075)
@santos22: Fix tests ahead of django-dynamic-fixture update (#7073)
@stsewd: Sphinx Search: don’t skip indexing if one file fails (#7071)
@stsewd: Search: generate full link from the server side (#7070)
@ericholscher: Fix PR builds being marked built (#7069)
@ericholscher: Add a page about choosing between .com/.org (#7068)
@ericholscher: Release 5.0.0 (#7064)
@stsewd: Search: Index more content from sphinx (#7063)
@santos22: Hide unbuilt versions in footer flyout (#7056)
@ericholscher: Docs: Refactor and simplify our docs (#7052)
@stsewd: Search Document: remove unused class methods (#7035)
@stsewd: Search: iterate over valid facets only (#7034)
@stsewd: RTDFacetedSearch: pass filters in one way only (#7032)
@dojutsu-user: Store Pageviews in DB (#6121)

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.

@ericholscher: Cleanup unresolver logging (#7019)
@ericholscher: Add CDN to the installed apps (#7014)
@eric-wieser: Emit a better error if no feature flag is found (#7009)
@ericholscher: Add proxito headers to redirect responses (#7007)
@ericholscher: Add Priority 0 to Celery (#7006)
@stsewd: Update conftest (#7002)
@ericholscher: Start storing JSON data for PR builds (#7001)
@yarikoptic: Add a note if build status is not being reported (#6999)
@stsewd: Update common (#6997)
@davidfischer: Exclusively handle proxito HSTS from the backend (#6994)
@humitos: Mention concurrent builds limitation in “Build Process” (#6993)
@humitos: Show a list of packages installed on environment (#6992)
@humitos: Document SHARE_SPHINX_DOCTREE flag (#6991)
@humitos: Contact us via email for Feature Flags (#6990)
@santos22: Alter field url on webhook (#6988)
@ericholscher: Log sync_repository_task when we run it (#6987)
@ericholscher: Remove old SSL cert warning, since they now work. (#6985)
@agjohnson: More fixes for automatic Docker limits (#6982)
@davidfischer: Add details to our changelog for 4.1.7 (#6978)
@ericholscher: Release 4.1.7 (#6976)
@humitos: Remove DOCKER_LIMITS (#6975)
@ericholscher: Catch infinite canonical redirects (#6973)
@eric-wieser: Ensure invoked Sphinx matches importable one (#6965)
@ericholscher: Add an unresolver similar to our resolver (#6944)
@stsewd: Add support for Mkdocs search (#6937)
@humitos: Optimization on sync_versions to use ls-remote on Git VCS (#6930)
@humitos: Split X-RTD-Version-Method header into two HTTP headers. (#6907)
@stsewd: Allow to override sign in and sign out views (#6901)
@stsewd: Hide version privacy (#6808)
@stsewd: Implement hidden state for versions (#6792)
@stsewd: Design doc for privacy levels (#6194)

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.

@ericholscher: Reduce proxito logging (#6970)
@humitos: Log build/sync tasks when triggered (#6967)
@humitos: Stop builders gracefully on SIGTERM (#6960)
@stsewd: Try to fix annotated tags (#6959)
@stsewd: Include query params in 404 redirects (#6957)
@ericholscher: Fix the trailing slash in our repo regexs (#6956)
@davidfischer: Add canonical to the Domain listview in the admin (#6954)
@davidfischer: Allow setting HSTS on a per domain basis (#6953)
@humitos: Refactor how we handle GitHub webhook events (#6949)
@humitos: Return 400 when importing an already existing project (#6948)
@humitos: Return max_concurrent_builds in ProjectAdminSerializer (#6946)
@tom-doerr: Update year (#6945)
@humitos: Revert “Use requests.head to query storage.exists” (#6941)
@ericholscher: Release 4.1.6 (#6940)
@stsewd: Remove note about search analytics being beta (#6939)
@stsewd: Add troubleshooting section for dev search docs (#6933)
@davidfischer: Index date and ID together on builds (#6926)
@davidfischer: CAA records are not only for users of Cloudflare DNS (#6925)
@davidfischer: Docs on supporting root domains (#6923)
@ericholscher: Add basic support for lower priority PR builds (#6921)
@ericholscher: Change the dashboard search to default to searching files (#6920)
@davidfischer: Canonicalize domains and redirect in proxito (#6905)
@zdover23: Made syntactical improvements and fixed some vocabulary issues. (#6825)

Version 4.1.6¶

Date: April 21, 2020

@stsewd: Revert usage of watchman (#6934)
@Mariatta: Fix typo: you -> your (#6931)
@humitos: Do not override the domain of Azure Storage (#6928)
@humitos: Per-project concurrency and check before triggering the build (#6927)
@davidfischer: Remove note about underscore in domain (#6924)
@stsewd: Pass INIT to azurite (#6918)
@humitos: Use requests.head to query storage.exists (#6917)
@stsewd: Bring back search highlight (#6914)
@ericholscher: Improve logging around status setting on PR builds (#6912)
@ericholscher: Add hoverxref to our docs (#6911)
@stsewd: Safely join storage paths (#6910)
@humitos: Release 4.1.5 (#6909)
@ericholscher: Fix Cache-Tag header name (#6908)
@stsewd: Handle paths with trailing / (#6906)
@ericholscher: Include the project slug in the PR context (#6904)
@ericholscher: Fix single version infinite redirect (#6900)
@humitos: Load YAML files safely (#6897)
@humitos: Use a custom Task Router to route tasks dynamically (#6849)
@zdover23: Made syntactical improvements and fixed some vocabulary issues. (#6825)
@humitos: Add CORS headers to Azurite (#6784)
@stsewd: Force to use proxied API for footer and search (#6768)
@ericholscher: Only output debug logging from RTD app (#6717)
@ericholscher: Add ability to sort dashboard by modified date (#6680)
@stsewd: Protection against None when sending notifications (#6610)
@stsewd: Guide: private python packages in .com (#6530)

Version 4.1.5¶

Date: April 15, 2020

@ericholscher: Fix Cache-Tag header name (#6908)
@stsewd: Handle paths with trailing / (#6906)
@ericholscher: Fix single version infinite redirect (#6900)
@ericholscher: Release 4.1.4 (#6899)
@humitos: On Azure .exists blob timeout, log the exception and return False (#6895)
@ericholscher: Fix URLs like /projects/subproject from 404ing when they don’t end with a slash (#6888)
@ericholscher: Allocate docker limits based on server size. (#6879)

Version 4.1.4¶

Date: April 14, 2020

@humitos: On Azure .exists blob timeout, log the exception and return False (#6895)
@ericholscher: Fix URLs like /projects/subproject from 404ing when they don’t end with a slash (#6888)
@ericholscher: Add CloudFlare Cache tags support (#6887)
@stsewd: Update requirements (#6885)
@stsewd: Be explicit with PUBLIC_DOMAIN setting (#6881)
@stsewd: Allow to override project detail view (#6880)
@ericholscher: Allocate docker limits based on server size. (#6879)
@ericholscher: Make the status name in CI configurable via setting (#6877)
@ericholscher: Add 12 hour caching to our robots.txt serving (#6876)
@humitos: Filter triggered builds when checking concurrency (#6875)
@ericholscher: Fix issue with sphinx domain types with : in them: (#6874)
@stsewd: Make dashboard faster for projects with a lot of subprojects (#6873)
@ericholscher: Release 4.1.3 (#6872)
@stsewd: Don’t do unnecessary queries when listing subprojects (#6869)
@stsewd: Optimize resolve_path (#6867)
@stsewd: Don’t do extra query if the project is a translation (#6865)
@stsewd: Remove private argument from resolver (#6864)
@stsewd: Support mkdocs html pages as doctype (#6846)
@stsewd: Reduce queries to storage to serve 404 pages (#6845)
@stsewd: Rework custom domains docs (#6844)
@stsewd: Add checking the github oauth app in the troubleshooting page (#6827)
@humitos: Return full path URL (including html) on /api/v2/docurl/ endpoint (#6082)

Version 4.1.3¶

Date: April 07, 2020

@stsewd: Don’t do unnecessary queries when listing subprojects (#6869)
@stsewd: Don’t do extra query if the project is a translation (#6865)
@stsewd: Remove private argument from resolver (#6864)
@ericholscher: Make development docs a bit easier to find (#6861)
@davidfischer: Add an advertising API timeout (#6856)
@humitos: Add more exceptions as WARNING log level (#6851)
@humitos: Limit concurrent builds (#6847)
@humitos: Release 4.1.2 (#6840)
@humitos: Report build status in a smarter way (#6839)
@stsewd: Update messages-extends to latest version (#6838)
@humitos: Do not save pip cache when using CACHED_ENVIRONMENT (#6820)
@stsewd: Force to reinstall package (#6817)
@ericholscher: Denormalize from_url_without_rest onto the redirects model (#6780)
@davidfischer: Developer docs emphasize the Docker setup (#6682)
@davidfischer: Document setting up connected accounts in dev (#6681)
@humitos: Return full path URL (including html) on /api/v2/docurl/ endpoint (#6082)

Version 4.1.2¶

Date: March 31, 2020

@humitos: Report build status in a smarter way (#6839)
@stsewd: Update messages-extends to latest version (#6838)
@humitos: Allow receiving None for template_html when sending emails (#6834)
@ericholscher: Fix silly issue with sync_callback (#6830)
@ericholscher: Show the builder in the Build admin (#6826)
@ericholscher: Properly call sync_callback when there aren’t any MULTIPLE_APP_SERVERS settings (#6823)
@stsewd: Allow to override app from where to read templates (#6821)
@humitos: Do not save pip cache when using CACHED_ENVIRONMENT (#6820)
@stsewd: Allow to override ProfileDetail view (#6819)
@ericholscher: Release 4.1.1 (#6818)
@stsewd: Force to reinstall package (#6817)
@humitos: Show uploading state (#6816)
@humitos: Use watchman when calling runserver in local development (#6813)
@humitos: Call proper handler (#6811)
@humitos: Show “Uploading” build state when uploading artifacts into storage (#6810)
@stsewd: Make search compatible with sphinx 2.2.1 (#6804)
@stsewd: Changes on 404, robots, and sitemap (#6798)
@humitos: Update guide about building consuming too much resources (#6778)

Version 4.1.1¶

Date: March 24, 2020

@stsewd: Force to reinstall package (#6817)
@humitos: Show uploading state (#6816)
@stsewd: Respect order when serving 404 (version -> default_version) (#6805)
@humitos: Use storage.open API correctly for tar files (build cached envs) (#6799)
@humitos: Check 404 page once when slug and default_version is the same (#6796)
@humitos: Do not reset the build start time when running build env (#6794)
@humitos: Skip .cache directory for cached builds if it does not exist (#6791)
@ericholscher: Remove GET args from the path passed via proxito header (#6790)
@stsewd: Check for /index on pages’ slug (#6789)
@ericholscher: Release 4.1.0 (#6788)
@ericholscher: Revert “Add feature flag to just completely skip sync and symlink operations (#6689)” (#6781)

Version 4.1.0¶

Date: March 17, 2020

@ericholscher: Properly proxy the Proxito headers via nginx/sendfile (#6782)
@ericholscher: Revert “Add feature flag to just completely skip sync and symlink operations (#6689)” (#6781)
@humitos: Upgrade django-storages to support URLs with more http methods (#6771)
@davidfischer: Use the hotfixed version of django-messages-extends (#6767)
@ericholscher: Release 4.0.3 (#6766)
@stsewd: Document usage or pytest marks (#6764)
@humitos: Pull/Push cached environment using storage (#6763)
@stsewd: Refactor search view to make use of permission_classes (#6761)
@stsewd: Run proxito tests with proxito (#6714)
@stsewd: Proxy footer api on docs’ domains (#6630)

Version 4.0.3¶

Date: March 10, 2020

@stsewd: Document usage or pytest marks (#6764)
@stsewd: Update some dependencies (#6762)
@stsewd: Refactor search view to make use of permission_classes (#6761)
@ericholscher: Revert “Merge pull request #6739 from readthedocs/agj/docs-tos-pdf” (#6760)
@ericholscher: Expand the logic in our proxito mixin. (#6759)
@comradekingu: Spelling: “Set up your environment” (#6752)
@humitos: Use storage.exists on HEAD method (#6751)
@humitos: Pull only latest image for development (#6750)
@humitos: Update common submodule (#6749)
@ericholscher: Release 4.0.2 (#6741)
@agjohnson: Add TOS PDF output (#6739)
@ericholscher: Don’t call virtualenv with --no-site-packages (#6738)
@GallowayJ: Drop mock dependency (#6723)
@stsewd: Run proxito tests with proxito (#6714)
@humitos: New block on footer template to override from corporate (#6702)
@humitos: Point users to support email instead asking to open an issue (#6650)
@stsewd: Proxy footer api on docs’ domains (#6630)

Version 4.0.2¶

Date: March 04, 2020

@ericholscher: Don’t call virtualenv with --no-site-packages (#6738)
@stsewd: Catch ConnectionError from request on api timing out (#6735)
@ericholscher: Release 4.0.1 (#6733)
@humitos: Improve Proxito 404 handler to render user-facing Maze when needed (#6726)

Version 4.0.1¶

Date: March 03, 2020

@ericholscher: Add feature flag for branch & tag syncing to API. (#6729)
@stsewd: Don’t fail a build on api timing out (#6719)
@stsewd: Be explicit on privacy level for search tests (#6713)
@stsewd: Make easy to run search tests in docker compose (#6711)
@davidfischer: Docker settings improvements (#6709)
@davidfischer: Workaround SameSite cookies (#6708)
@davidfischer: Figure out the host IP when using Docker (#6707)
@davidfischer: Pin the version of Azurite for docker-compose development (#6706)
@ericholscher: Release 4.0.0 (#6704)
@humitos: Rename docker settings to fix local environment (#6703)
@sduthil: API v3 doc: fix typos in URL for PATCH /versions/slug/ (#6698)
@humitos: Sort versions in-place to help performance (#6696)
@humitos: Use .iterator when sorting versions (#6694)
@agjohnson: Add feature flag to just completely skip sync and symlink operations (#6689)
@humitos: Disable more loggings in development environment (#6683)
@davidfischer: Use x-forwarded-host in local docker environment (#6679)
@humitos: Allow user to set build.image: testing in the config file (#6676)
@agjohnson: Add azurite –loose option (#6669)
@stsewd: Have more control over search tests (#6644)
@davidfischer: Enable content security policy in report-only mode (#6642)
@stsewd: Add test settings file for proxito (#6623)
@stsewd: Guide: using private submodules in rtd.com (#6527)

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.

@stsewd: Data migration for old integration models (#6675)
@ericholscher: Release 3.12.0 (#6674)
@humitos: Upgrade to Django 2.2.9 (#6494)
@davidfischer: Show message if version list truncated (#6276)

Version 3.12.0¶

Date: February 18, 2020

This version has two major changes:

It updates our default docker images to stable=5.0 and latest=6.0.
It changes our PR builder domain to readthedocs.build
@humitos: Use PUBLIC_DOMAIN_USES_HTTPS for resolver tests (#6673)
@stsewd: Always run CoreTagsTests with http (#6671)
@ericholscher: Remove old docker settings (#6670)
@stsewd: Update gitpython and django (#6667)
@humitos: New docker release (6.0 and testing) (#6654)
@humitos: Default python version per Docker image (#6653)
@stsewd: Add pytest-custom_exit_code (#6648)
@ericholscher: Initial attempt to serve PR builds at readthedocs.build (#6629)
@ericholscher: Remove re-authing of users on downloads. (#6619)
@stsewd: Don’t trigger a sync twice on creation/deletion for GitHub (#6614)
@s-weigand: Add linkcheck test for the docs (#6543)

Version 3.11.6¶

Date: February 04, 2020

@ericholscher: Note we aren’t doing GSOC in 2020 (#6618)
@ericholscher: only serve x-rtd-slug project if it exists (#6617)
@ericholscher: Add check for a single_version project having a version_slug for PR builds (#6615)
@stsewd: Fix linter (#6613)
@stsewd: Create unique container per sync (#6612)
@stsewd: Check for None before assignment (#6611)
@ericholscher: Raise exception when we get an InfiniteRedirect (#6609)
@ericholscher: Release 3.11.5 (#6608)
@humitos: Avoid infinite redirect on El Proxito on 404 (#6606)
@stsewd: Don’t error when killing/removing non-existent container (#6605)
@humitos: Use proper path to download/install readthedocs-ext (#6603)
@humitos: Use timeout on internal API calls (#6602)
@stsewd: Don’t assume build isn’t None in a docker build env (#6599)
@ericholscher: Fix issue with pip 20.0 breaking on install (#6598)
@stsewd: More protection against None (#6597)
@agjohnson: Revert “Update celery requirements to its latest version” (#6596)
@Blackcipher101: Changed documentation of Api v3 (#6574)
@ericholscher: Use our standard auth mixin for proxito downloads (#6572)
@humitos: Move common docker compose configs to common repository (#6539)

Version 3.11.5¶

Date: January 29, 2020

@humitos: Avoid infinite redirect on El Proxito on 404 (#6606)
@humitos: Use proper path to download/install readthedocs-ext (#6603)
@stsewd: Don’t assume build isn’t None in a docker build env (#6599)
@ericholscher: Fix issue with pip 20.0 breaking on install (#6598)
@agjohnson: Revert “Update celery requirements to its latest version” (#6596)
@stsewd: Remove .cache from parent dir (#6595)
@agjohnson: Release 3.11.4 again (#6594)
@agjohnson: Release 3.11.4 (#6593)
@ericholscher: Use our standard auth mixin for proxito downloads (#6572)
@stsewd: Migrate doctype from project to version (#6523)

Version 3.11.4¶

Date: January 28, 2020

@humitos: Disable django debug toolbar in El Proxito (#6591)
@stsewd: Respect docker setting on repo sync (#6589)
@humitos: Merge pull request #6588 from readthedocs/humitos/support-ext (#6588)
@humitos: Fix argument of update_repos (#6583)
@humitos: Mount proper shared docker volume (#6581)
@ericholscher: Use our standard auth mixin for proxito downloads (#6572)
@stsewd: Delete .cache dir on wipe (#6571)
@humitos: Run old redirect tests via El Proxito (#6570)
@humitos: Remove ‘build environment’ from guides (#6568)
@ericholscher: Fix /en/latest redirects (#6564)
@stsewd: Merge pull request #6561 from stsewd/move-method (#6561)
@stsewd: Use settings override in footer (#6560)
@ericholscher: Fix proxito redirects breaking without a / (#6558)
@stsewd: Remove unused file (#6557)
@mgeier: DOC: Change a lot of http links to https (#6553)
@stsewd: Don’t use an instance of VCS when isn’t needed (#6548)
@saadmk11: Add GitHub OAuth App Permission issue to PR Builder Troubleshooting docs (#6547)
@humitos: Move common docker compose configs to common repository (#6539)
@preetmishra: Update Transifex Integration details in Internationalization page. (#6531)
@stsewd: Migrate doctype from project to version (#6523)
@stsewd: Simplify docker image (#6519)
@Parth1811: Fixes #5388 – Added Documentation for constraint while using Conda (#6509)
@stsewd: Improve test for sync_repo (#6504)
@humitos: Show debug toolbar when running docker compose (#6488)
@dibyaaaaax: Add python examples for API v3 Documentation (#6487)

Version 3.11.3¶

Date: January 21, 2020

@ericholscher: Pass proper path to redirect code (#6555)
@Daniel-Mietchen: Fixing a broken link (#6550)
@stsewd: Guide: Intersphinx in Read the Docs (#6520)
@humitos: Add netcat and telnet for celery debugging with rdb (#6518)
@humitos: Core team development standards guide (#6517)
@dibyaaaaax: Add www to the broken link (#6513)
@davidfischer: Don’t allow empty tags (#6512)
@Parth1811: Fixes #6510 – Removed the show_analytics checks from the template (#6511)
@stsewd: Only install node on eslint step on travis (#6505)
@stsewd: Don’t pass build to environment when doing a sync (#6503)
@ericholscher: Release 3.11.2 (#6502)
@Blackcipher101: Added “dirhtml” target (#6500)
@humitos: Use CELERY_APP_NAME to call the proper celery app (#6499)
@stsewd: Copy path from host only when using a LocalBuildEnviroment (#6482)
@stsewd: Set env variables in the same way for DockerBuildEnvironment and Loc… (#6481)
@stsewd: Use environment variable per run, not per container (#6480)
@humitos: Update celery requirements to its latest version (#6448)
@stsewd: Execute checkout step respecting docker setting (#6436)
@humitos: Serve non-html at documentation domain though El Proxito (#6419)

Version 3.11.2¶

Date: January 08, 2020

@ericholscher: Fix link to my blog post breaking https (#6495)
@humitos: Use a fixed IP for NGINX under docker-compose (#6491)
@humitos: Add ‘index.html’ to the path before using storage.url(path) (#6476)
@agjohnson: Release 3.11.1 (#6473)
@humitos: Use tasks from common (including docker ones) (#6471)
@humitos: Upgrade Django due a security issue (#6470)
@humitos: Fix celery auto-reload command (#6469)
@humitos: Use django storage to build URL returned by El Proxito (#6466)
@ericholscher: Handle GitHub Push events with deleted: true in the JSON (#6465)
@humitos: Serve external version through El Proxito (#6434)
@segevfiner: Remove a stray backtick from import-guide.rst (#6362)

Version 3.11.1¶

Date: December 18, 2019

@humitos: Upgrade Django due a security issue (#6470)
@humitos: Use django storage to build URL returned by El Proxito (#6466)
@ericholscher: Handle GitHub Push events with deleted: true in the JSON (#6465)
@ericholscher: Update troubleshooting steps for PR builder (#6463)
@ericholscher: Add DOCKER_NORELOAD to compose settings (#6461)
@stsewd: Be explicit when using setup_env (#6451)
@keshavvinayak01: Fixed remove_search_analytics issue (#6447)
@saadmk11: Fix logic to build internal/external versions on update_repos management command (#6442)
@humitos: Refactor get_downloads to make one query for default_version (#6441)
@humitos: Do not expose env variables on external versions (#6440)
@humitos: Better ES settings on docker-compose (#6439)
@humitos: Remove global pip cache (#6437)
@humitos: Bring Azure storage backend classes to this repository (#6433)
@stsewd: Show predefined match on automation rules admin (#6432)
@stsewd: Override production domain explicitly (#6431)
@humitos: inv tasks to use when developing with docker (#6418)
@piyushpalawat99: Fix #6395 (#6402)
@stsewd: Only pass public versions to html context (#6118)
@ericholscher: Add an “Edit Versions” listing to the Admin menu (#6110)
@saadmk11: Extend webhook notifications with build status (#5621)

Version 3.11.0¶

Date: December 03, 2019

@davidfischer: Use media availability instead of querying the filesystem (#6428)
@stsewd: Remove beta note about sharing by password and header auth (#6426)
@humitos: Use trigger_build for update_repos command (#6422)
@humitos: Add more supported field to APIv3 docs (#6417)
@humitos: Add AuthenticationMiddleware to El Proxito tests (#6416)
@stsewd: Update docs on sharing (#6410)
@humitos: Use WORKDIR to cd into a directory in Dockerfile (#6409)
@humitos: Use /data inside Azurite container to persist data (#6407)
@humitos: Serve non-html files from nginx (X-Accel-Redirect) (#6404)
@humitos: Perform redirects at DB level (#6398)
@humitos: Allow to extend El Proxito views from commercial (#6397)
@humitos: Migrate El Proxito views to class-based views (#6396)
@agjohnson: Fix CSS and how we were handling html in automation rule UI (#6394)
@ericholscher: Release 3.10.0 (#6391)
@stsewd: Set privacy level explicitly (#6390)
@ericholscher: Redirect index files in proxito instead of serving (#6387)
@humitos: Fully working docker-compose file (#6295)
@saadmk11: Refactor Subproject validation to use it for Forms and API (#6285)
@saadmk11: Refactor Gold Views (#6272)
@stsewd: Add docs for automatin rules (#6072)

Version 3.10.0¶

Date: November 19, 2019

@stsewd: Set privacy level explicitly (#6390)
@ericholscher: Redirect index files in proxito instead of serving (#6387)
@stsewd: Fix search indexing (#6380)
@humitos: Include creditcard.png image (#6379)
@stsewd: Silent curl (#6377)
@stsewd: Use github actions to trigger tests in corporate (#6376)
@saadmk11: Show only users projects in the APIv3 browsable form (#6374)
@humitos: Release 3.9.0 (#6371)
@davidfischer: Pin the node dependencies with a package-lock (#6370)
@ericholscher: Small optimization to not compute the highest version when it isn’t displayed (#6360)
@krptic07: remove rss feed (#6348)
@pyup-bot: pyup: Scheduled weekly dependency update for week 44 (#6347)
@ericholscher: Port additional features to proxito (#6286)
@stsewd: Add docs for automatin rules (#6072)
@stsewd: Implement UI for automation rules (#5996)

Version 3.9.0¶

Date: November 12, 2019

@davidfischer: Pin the node dependencies with a package-lock (#6370)
@humitos: Force PUBLIC_DOMAIN_USES_HTTPS on version compare tests (#6367)
@segevfiner: Remove a stray backtick from import-guide.rst (#6362)
@stsewd: Don’t compare inactive or non build versions (#6361)
@stsewd: Fix test (#6358)
@ericholscher: Change the default of proxied_api_host to api_host (#6355)
@stsewd: Dont link to dashboard from footer (#6353)
@humitos: Upgrade django-storages (#6339)
@pyup-bot: pyup: Scheduled weekly dependency update for week 43 (#6334)
@KartikKapil: added previous year gsoc projects (#6333)
@stsewd: Support 6.0rc1 build image (#6329)
@stsewd: Don’t error on non existing version (#6325)
@stsewd: Remove files from storage and delete indexes from ES when no longer needed (#6323)
@stsewd: Fix eslint (#6317)
@humitos: Revert “Adding RTD prefix for docker only in setting.py and all… (#6315)
@anindyamanna: Fixed Broken links (#6300)
@stsewd: Use sync instead of copy for blob storage (#6298)
@sciencewhiz: Fix missing word in wipe guide (#6294)
@jaferkhan: Removed unused code from view and template (#6250) (#6288)
@stsewd: Rename test name (#6283)
@davidfischer: Store version media availability (#6278)
@davidfischer: Link to the terms of service (#6277)
@saadmk11: API V3 Subproject Creation Bug fix (#6275)
@stsewd: Fix footer (#6274)
@stsewd: Fix tests (#6269)
@stsewd: Refactor profile’s views (#6267)
@humitos: Default to None when using the Serializer as Form for Browsable… (#6266)
@ericholscher: Fix inactive version list not showing when no results returned (#6264)
@ericholscher: Downgrade django-storges. (#6263)
@ericholscher: Release 3.8.0 (#6262)
@stsewd: Update doccs version detail (api v3) (#6259)
@stsewd: Merge #6176 to master (#6258)
@humitos: Remove privacy_level field from APIv3 (#6257)
@saadmk11: Redirect /projects/ URL to /dashboard/ (#6255)
@davidfischer: Allow project badges for private version (#6252)
@stsewd: Add pub_date to project admin (#6244)
@saadmk11: Allow only post requests for delete views (#6242)
@Iamshankhadeep: Changing created to modified time (#6234)
@ericholscher: Initial stub of proxito (#6226)
@saadmk11: Add Better error message for lists in config file (#6200)
@stsewd: Put view under login (#6193)
@humitos: Ship API v3 (#6169)
@stsewd: Protection against ReDoS (#6163)
@dojutsu-user: Optimize json parsing (#6160)
@tapaswenipathak: Added missing i18n for footer api (#6144)
@stsewd: Use different setting for footer api url (#6131)
@dojutsu-user: Remove ‘highlight’ URL param from search results (#6087)
@Iamshankhadeep: Adding RTD prefix for docker only in setting.py and all other places where is needed (#6040)
@stsewd: Design doc for organizations (#5958)

Version 3.8.0¶

Date: October 09, 2019

@stsewd: Update doccs version detail (api v3) (#6259)
@stsewd: Merge #6176 to master (#6258)
@humitos: Remove privacy_level field from APIv3 (#6257)
@saadmk11: Redirect /projects/ URL to /dashboard/ (#6255)
@davidfischer: Allow project badges for private version (#6252)
@pyup-bot: pyup: Scheduled weekly dependency update for week 40 (#6251)
@saadmk11: Add note about specifying dependencies (#6248)
@stsewd: Add pub_date to project admin (#6244)
@humitos: Do not use –cache-dir for pip if CLEAN_AFTER_BUILD is enabled (#6239)
@stsewd: Update pytest (#6233)
@iambenzo: remove /projects/ (#6228)
@ericholscher: Initial stub of proxito (#6226)
@davidfischer: Improve the version listview (#6224)
@stsewd: Override production media artifacts on test (#6220)
@davidfischer: Customize default build media storage for the FS (#6215)
@agjohnson: Release 3.7.5 (#6214)
@stsewd: Remove dead code (#6213)
@stsewd: Only use the sphinx way to mock (#6212)
@saadmk11: Only Build Active Versions from Build List Page Form (#6205)
@saadmk11: Make raw_config private (#6199)
@Iamshankhadeep: moved expandable_fields to meta class (#6198)
@stsewd: Put view under login (#6193)
@dojutsu-user: Remove pie-chart from search analytics page (#6192)
@stsewd: Refactor SearchAnalytics view (#6190)
@stsewd: Refactor ProjectRedirects views (#6187)
@stsewd: Refactor ProjectTranslations views (#6185)
@stsewd: Refactor ProjectNotications views (#6183)
@stsewd: Refactor views ProjectUsers (#6178)
@humitos: Create subproject relationship via APIv3 endpoint (#6176)
@stsewd: Refactor views ProjectVersion (#6175)
@davidfischer: Add terms of service (#6174)
@davidfischer: Document connected account permissions (#6172)
@stsewd: Refactor views projects (#6171)
@dojutsu-user: Optimize json parsing (#6160)
@humitos: APIv3 endpoint: allow to modify a Project once it’s imported (#5952)

Version 3.7.5¶

Date: September 26, 2019

@davidfischer: Remove if storage blocks (#6191)
@davidfischer: Update security docs (#6179)
@davidfischer: Add the private spamfighting module to INSTALLED_APPS (#6177)
@davidfischer: Document connected account permissions (#6172)
@stsewd: Require login for old redirect (#6170)
@humitos: Remove old and unused code (#6167)
@stsewd: Clean up views (#6166)
@stsewd: Update docs for sharing (#6164)
@pyup-bot: pyup: Scheduled weekly dependency update for week 36 (#6158)
@saadmk11: Remove PR Builder Project Idea from RTD GSoC Docs (#6147)
@ericholscher: Serialize time in search queries properly (#6142)
@humitos: Allow to extend DomainCreate view (#6139)
@saadmk11: Integration Re-sync Bug Fix (#6124)
@stsewd: Don’t log BuildEnvironmentWarning as error (#6112)
@dojutsu-user: Add Search Guide (#6101)
@saadmk11: Add PR Builder guide to docs (#6093)
@dojutsu-user: Record search queries smartly (#6088)
@dojutsu-user: Remove ‘highlight’ URL param from search results (#6087)

Version 3.7.4¶

Date: September 05, 2019

@ericholscher: Remove paid support callout (#6140)
@ericholscher: Fix IntegrationAdmin with raw_id_fields for Projects (#6136)
@ericholscher: Fix link to html_extra_path (#6135)
@stsewd: Move out authorization from FooterHTML view (#6133)
@agjohnson: Add setting for always cleaning the build post-build (#6132)
@pyup-bot: pyup: Scheduled weekly dependency update for week 35 (#6129)
@stsewd: Refactor footer_html view to class (#6125)
@ericholscher: Use raw_id_fields in the TokenAdmin (#6116)
@davidfischer: Fixed footer ads supported on all themes (#6115)
@stsewd: Don’t log BuildEnvironmentWarning as error (#6112)
@pllim: Use the force when fetching with Git (#6109)
@dojutsu-user: Record search queries smartly (#6088)
@stsewd: Add move method to automation rule (#5998)
@dojutsu-user: Index more domain data into elasticsearch (#5979)

Version 3.7.3¶

Date: August 27, 2019

@pllim: Use the force when fetching with Git (#6109)
@davidfischer: Small improvements to the SEO guide (#6105)
@davidfischer: Update intersphinx mapping with canonical sources (#6085)
@davidfischer: Fix lingering 500 issues (#6079)
@davidfischer: Technical docs SEO guide (#6077)
@saadmk11: GitLab Build Status Reporting for PR Builder (#6076)
@davidfischer: Update ad details docs (#6074)
@davidfischer: Gold makes projects ad-free again (#6073)
@saadmk11: Auto Sync and Re-Sync for Manually Created Integrations (#6071)
@pyup-bot: pyup: Scheduled weekly dependency update for week 32 (#6067)
@saadmk11: PR Builder GitLab Integration (#6066)
@davidfischer: Send media downloads to analytics (#6063)
@davidfischer: IPv6 in X-Forwarded-For fix (#6062)
@humitos: Remove warning about beta state of conda support (#6056)
@saadmk11: Update GitLab Webhook creating to enable merge request events (#6055)
@ericholscher: Release 3.7.2 (#6054)
@dojutsu-user: Update feature flags docs (#6053)
@saadmk11: Add indelx.html filename to the external doc url (#6051)
@dojutsu-user: Search analytics improvements (#6050)
@stsewd: Sort versions taking into consideration the vcs type (#6049)
@humitos: Avoid returning invalid domain when using USE_SUBDOMAIN=True in dev (#6026)
@dojutsu-user: Search analytics (#6019)
@tapaswenipathak: Remove django-guardian model (#6005)
@stsewd: Add manager and description field to AutomationRule model (#5995)
@davidfischer: Cleanup project tags (#5983)
@davidfischer: Search indexing with storage (#5854)
@wilvk: fix sphinx startup guide to not to fail on rtd build as per #2569 (#5753)

Version 3.7.2¶

Date: August 08, 2019

@dojutsu-user: Update feature flags docs (#6053)
@saadmk11: Add indelx.html filename to the external doc url (#6051)
@dojutsu-user: Search analytics improvements (#6050)
@stsewd: Sort versions taking into consideration the vcs type (#6049)
@ericholscher: When called via SyncRepositoryTaskStep this doesn’t exist (#6048)
@davidfischer: Fix around community ads with an explicit ad placement (#6047)
@ericholscher: Release 3.7.1 (#6045)
@saadmk11: Do not delete media storage files for external version (#6035)
@tapaswenipathak: Remove django-guardian model (#6005)
@davidfischer: Cleanup project tags (#5983)
@davidfischer: Search indexing with storage (#5854)

Version 3.7.1¶

Date: August 07, 2019

@pyup-bot: pyup: Scheduled weekly dependency update for week 31 (#6042)
@agjohnson: Fix issue with save on translation form (#6037)
@saadmk11: Do not delete media storage files for external version (#6035)
@saadmk11: Do not show wipe version message on build details page for External versions (#6034)
@saadmk11: Send site notification on Build status reporting failure and follow DRY (#6033)
@davidfischer: Use Read the Docs for Business everywhere (#6029)
@davidfischer: Remove project count on homepage (#6028)
@stsewd: Fix missing arg in tests (#6022)
@ericholscher: Update get_absolute_url for External Versions (#6020)
@dojutsu-user: Search analytics (#6019)
@saadmk11: Fix issues around remote repository for sending Build status reports (#6017)
@ericholscher: Expand the scope between before_vcs and after_vcs (#6015)
@davidfischer: Handle .x in version sorting (#6012)
@tapaswenipathak: Update note (#6008)
@davidfischer: Link to Read the Docs for Business docs from relevant sections (#6004)
@davidfischer: Note RTD for Biz requires SSL for custom domains (#6003)
@davidfischer: Allow searching in the Django Admin for gold (#6001)
@saadmk11: More explicit tests for build managers (#6000)
@dojutsu-user: Fix logic involving creation of Sphinx Domains (#5997)
@dojutsu-user: Fix: no highlighting of matched keywords in search results (#5994)
@saadmk11: Do not copy external version artifacts twice (#5992)
@saadmk11: Update GitHub build status details URL (#5987)
@humitos: Missing list.extend line when appending conda dependencies (#5986)
@saadmk11: Fix github build status reporting bug (#5985)
@dojutsu-user: Use try…catch block with underscore.js template. (#5984)
@davidfischer: Cleanup project tags (#5983)
@ericholscher: Release 3.7.0 (#5982)
@stsewd: More explicit tests for version managers (#5981)
@dojutsu-user: Search Fix: section_subtitle_link is not defined (#5980)
@stsewd: More explicit setup for tests (#5977)
@pyup-bot: pyup: Scheduled weekly dependency update for week 29 (#5975)
@stsewd: Update gitpython (#5974)
@davidfischer: Community only ads for more themes (#5973)
@darrowco: updated to psycopg2 (2.8.3) (#5965)
@humitos: Append core requirements to Conda environment file (#5956)
@humitos: Show APIv3 Token under Profile settings (#5954)
@stsewd: Remove skip submodules flag (#5406)

Version 3.7.0¶

Date: July 23, 2019

@dojutsu-user: Search Fix: section_subtitle_link is not defined (#5980)
@stsewd: More explicit setup for tests (#5977)
@stsewd: Update gitpython (#5974)
@davidfischer: Community only ads for more themes (#5973)
@kittenking: Fix typos across readthedocs.org repository (#5971)
@dojutsu-user: Fix: parse_json also including html in titles (#5970)
@saadmk11: update external version check for notification task (#5969)
@pranay414: Improve error message for invalid submodule URLs (#5957)
@humitos: Append core requirements to Conda environment file (#5956)
@Abhi-khandelwal: Exclude Spam projects count from total_projects count (#5955)
@humitos: Show APIv3 Token under Profile settings (#5954)
@ericholscher: Release 3.6.1 (#5953)
@ericholscher: Missed a couple places to set READTHEDOCS_LANGUAGE (#5951)
@dojutsu-user: Hotfix: Return empty dict when no highlight dict is present (#5950)
@humitos: Use a cwd where the user has access inside the container (#5949)
@saadmk11: Small Changes to PR Builder Code (#5948)
@saadmk11: update build status message for github (#5947)
@ericholscher: Integrate indoc search into our prod docs (#5946)
@ericholscher: Explicitly delete SphinxDomain objects from previous versions (#5945)
@ericholscher: Properly return None when there’s no highlight on a hit. (#5944)
@ericholscher: Add READTHEDOCS_LANGUAGE to the environment during builds (#5941)
@ericholscher: Merge the GSOC 2019 in-doc search changes (#5919)
@saadmk11: Add check for external version in conf.py.tmpl for warning banner (#5900)
@Abhi-khandelwal: Point users to commercial solution for their private repositories (#5849)
@ericholscher: Merge initial work from Pull Request Builder GSOC (#5823)

Version 3.6.1¶

Date: July 17, 2019

@ericholscher: Missed a couple places to set READTHEDOCS_LANGUAGE (#5951)
@dojutsu-user: Hotfix: Return empty dict when no highlight dict is present (#5950)
@humitos: Use a cwd where the user has access inside the container (#5949)
@saadmk11: Small Changes to PR Builder Code (#5948)
@ericholscher: Explicitly delete SphinxDomain objects from previous versions (#5945)
@ericholscher: Properly return None when there’s no highlight on a hit. (#5944)
@ericholscher: Release 3.6.0 (#5943)
@ericholscher: Bump the Sphinx extension to 1.0 (#5942)
@ericholscher: Add READTHEDOCS_LANGUAGE to the environment during builds (#5941)
@dojutsu-user: Small search doc fix (#5940)
@dojutsu-user: Indexing speedup (#5939)
@dojutsu-user: Small improvement in parse_json (#5938)
@dojutsu-user: Use attrgetter in sorted function (#5936)
@saadmk11: Refine PR Builder Code (#5933)
@dojutsu-user: Fix spacing between the results and add highlight url param (#5932)
@ericholscher: Merge the GSOC 2019 in-doc search changes (#5919)
@dojutsu-user: Add tests for section-linking (#5918)
@saadmk11: Update build list and detail page UX (#5916)
@humitos: APIv3 endpoint to manage Environment Variables (#5913)
@humitos: Split APIv3 tests on different files (#5911)
@stsewd: Better msg when gitpython fails (#5903)
@saadmk11: Add check for external version in conf.py.tmpl for warning banner (#5900)
@humitos: Update APIv3 documentation with latest changes (#5895)

Version 3.6.0¶

Date: July 16, 2019

@ericholscher: Bump the Sphinx extension to 1.0 (#5942)
@ericholscher: Add READTHEDOCS_LANGUAGE to the environment during builds (#5941)
@dojutsu-user: Small search doc fix (#5940)
@dojutsu-user: Indexing speedup (#5939)
@dojutsu-user: Small improvement in parse_json (#5938)
@dojutsu-user: Use attrgetter in sorted function (#5936)
@saadmk11: Refine PR Builder Code (#5933)
@dojutsu-user: Fix spacing between the results and add highlight url param (#5932)
@Abhi-khandelwal: remove the usage of six (#5930)
@dojutsu-user: Fix count value of docsearch REST api (#5926)
@ericholscher: Merge the GSOC 2019 in-doc search changes (#5919)
@dojutsu-user: Add tests for section-linking (#5918)
@saadmk11: Update build list and detail page UX (#5916)
@humitos: These Project’s methods are not used (#5915)
@saadmk11: Github Status reporting Test fix (#5914)
@humitos: APIv3 endpoint to manage Environment Variables (#5913)
@humitos: Split APIv3 tests on different files (#5911)
@saadmk11: Add Feature Flag to Enable External Version Building (#5910)
@ericholscher: Pass the build_pk to the task instead of the build object itself (#5904)
@stsewd: Better msg when gitpython fails (#5903)
@saadmk11: Exclude external versions from get_latest_build (#5901)
@humitos: Update conda at startup (#5897)
@humitos: Update APIv3 documentation with latest changes (#5895)
@stsewd: Add tests for version and project querysets (#5894)
@davidfischer: Rework on documentation guides (#5893)
@humitos: Lint (pep257: D415) (#5892)
@davidfischer: Fix spaces in email subject link (#5891)
@saadmk11: Build only HTML and Save external version artifacts in different directory (#5886)
@humitos: APIv3 CRUD for Redirect objects (#5879)
@ericholscher: Add config to Build and Version admin (#5877)
@pyup-bot: pyup: Scheduled weekly dependency update for week 26 (#5874)
@stsewd: Call distinct to the end of the querysets (#5872)
@pranay414: Change rtfd to readthedocs (#5871)
@humitos: APIv3 refactor some fields (#5868)
@saadmk11: Send Build Status Report Using GitHub Status API (#5865)
@humitos: APIv3 “Import Project” endpoint (#5857)
@stsewd: Remove django guardian from querysets (#5853)
@humitos: Hide “Protected” privacy level from users (#5833)
@dojutsu-user: Add section linking for the search result (#5829)

Version 3.5.3¶

Date: June 19, 2019

@davidfischer: Treat docs warnings as errors (#5825)
@davidfischer: Fix some unclear verbiage (#5820)
@davidfischer: Rework documentation index page (#5819)
@davidfischer: Upgrade intersphinx to Django 1.11 (#5818)
@pyup-bot: pyup: Scheduled weekly dependency update for week 24 (#5817)
@humitos: Disable changing domain when editing the object (#5816)
@saadmk11: Update docs with sitemap sort order change (#5815)
@davidfischer: Optimize requests to APIv3 (#5803)
@ericholscher: Show build length in the admin (#5802)
@stsewd: Move search functions (#5801)
@ericholscher: A few small improvements to help with search admin stuff (#5800)
@stsewd: Simplify es indexing (#5798)
@humitos: Use a real SessionBase object on FooterNoSessionMiddleware (#5797)
@stsewd: Add logging in magic methods (#5795)
@stsewd: Fix unbound var in search view (#5794)
@davidfischer: Mention security issue in the changelog (#5790)
@stsewd: Index path with original path name (#5785)
@stsewd: Use querysets from the class not from an instance (#5783)
@saadmk11: Add Build managers and Update Build Querysets. (#5779)
@davidfischer: Project advertising page/form update (#5777)
@davidfischer: Update docs around opt-out of ads (#5776)
@saadmk11: Sitemap sort order priorities updated (#5724)
@dojutsu-user: [Design Doc] In Doc Search UI (#5707)
@saadmk11: Pull Request Builder Design Doc (#5705)
@humitos: Support single version subprojects URLs to serve from Django (#5690)
@agjohnson: Add a contrib Dockerfile for local build image on Linux (#4608)

Version 3.5.2¶

This is a quick hotfix to the previous version.

Date: June 11, 2019

@ericholscher: Fix version of our sphinx-ext we’re installing (#5789)
@stsewd: Get version from the api (#5788)

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

@stsewd: Update build images in docs (#5782)
@saadmk11: Validate dict when parsing the mkdocs.yml file (#5775)
@stsewd: Pin textclassifier dependencies (#5773)
@stsewd: Fix tests on master (#5769)
@stsewd: Don’t use implicit relative import (#5767)
@stsewd: Use version_pk to trigger builds (#5765)
@davidfischer: Domain UI improvements (#5764)
@ericholscher: Try to fix Elastic connection pooling issues (#5763)
@pyup-bot: pyup: Scheduled weekly dependency update for week 22 (#5762)
@ericholscher: Try to fix Elastic connection pooling issues (#5760)
@davidfischer: Escape variables in mkdocs data (#5759)
@humitos: Serve 404/index.html file for htmldir Sphinx builder (#5754)
@wilvk: fix sphinx startup guide to not to fail on rtd build as per #2569 (#5753)
@stsewd: Fix mkdocs relpath (#5749)
@stsewd: Call lock per task (#5748)
@stsewd: Pin kombu to 4.3.0 (#5747)
@agjohnson: Clarify latexmk option usage (#5745)
@ericholscher: Hotfix latexmx builder to ignore error codes (#5744)
@ericholscher: Hide the Code API search in the UX for now. (#5743)
@davidfischer: Add init.py under readthedocs/api (#5742)
@dojutsu-user: Fix design docs missing from toctree (#5741)
@ericholscher: Release 3.5.0 (#5740)
@saadmk11: Pytest Timezone Warning Fixed (#5739)
@humitos: Filter by projects with no banned users (#5733)
@davidfischer: Fix the sidebar ad color (#5731)
@saadmk11: Permanent redirect feature added (#5727)
@humitos: Move version “Clean” button to details page (#5706)
@gorshunovr: Update flags documentation (#5701)
@davidfischer: Storage updates (#5698)
@stsewd: Remove files after build (#5680)
@stsewd: Move community support to email (#5651)
@davidfischer: Optimizations and UX improvements to the dashboard screen (#5637)
@chrisjsewell: Use --upgrade instead of --force-reinstall for pip installs (#5635)
@stsewd: Move file validations out of the config module (#5627)
@humitos: Remove old/deprecated build endpoints (#5479)
@shivanshu1234: Add link to in-progress build from dashboard. (#5431)
@stsewd: Downgrade pytest-django (#5294)

Version 3.5.0¶

Date: May 30, 2019

@pyup-bot: pyup: Scheduled weekly dependency update for week 21 (#5737)
@humitos: Update feature flags exposed to user in docs (#5734)
@davidfischer: Fix the sidebar ad color (#5731)
@davidfischer: Create a funding file (#5729)
@davidfischer: Small commercial hosting page rework (#5728)
@mattparrilla: Add note about lack of support for private repos (#5726)
@humitos: Canonical consistency example (#5722)
@humitos: Use nonstopmode for latexmk (#5714)
@cclauss: Identity is not the same thing as equality in Python (#5713)
@pyup-bot: pyup: Scheduled weekly dependency update for week 20 (#5712)
@humitos: Move version “Clean” button to details page (#5706)
@ericholscher: Explicitly mention a support email (#5703)
@davidfischer: Storage updates (#5698)
@humitos: Enable auth validate passwords (#5696)
@stsewd: Simplify lock acquire (#5695)
@stsewd: Simplify update docs task (#5694)
@pyup-bot: pyup: Scheduled weekly dependency update for week 19 (#5692)
@saadmk11: Warning about using sqlite 3.26.0 for development (#5681)
@davidfischer: Configure the security middleware (#5679)
@stsewd: Fix bug in notifications (#5678)
@pyup-bot: pyup: Scheduled weekly dependency update for week 18 (#5667)
@saadmk11: pylint fix for notifications, restapi and config (#5664)
@saadmk11: pylint fix for readthedocs.search (#5663)
@saadmk11: pylint fix for readthedocs.projects (#5662)
@saadmk11: pylint fix for readthedocs.doc_builder (#5660)
@humitos: Support Docker 5.0 image (#5657)
@humitos: Use latexmk if Sphinx > 1.6 (#5656)
@humitos: Upgrade docker python package to latest release (#5654)
@saadmk11: pylint fix for readthedocs.core (#5650)
@pyup-bot: pyup: Scheduled weekly dependency update for week 17 (#5645)
@saadmk11: Serve custom 404 pages from Django (#5644)
@yarons: Typo fix (#5642)
@saadmk11: Sitemap hreflang syntax invalid for regional language variants fix (#5638)
@davidfischer: Optimizations and UX improvements to the dashboard screen (#5637)
@davidfischer: Redirect project slugs with underscores (#5634)
@saadmk11: Standardizing the use of settings directly (#5632)
@saadmk11: Note for Docker image size in Docker instructions (#5630)
@davidfischer: UX improvements around SSL certificates (#5629)
@davidfischer: Gold project sponsorship changes (#5628)
@davidfischer: Make sure there’s a contact when opting out of advertising (#5626)
@stsewd: Remove unused volume from docker (#5625)
@dojutsu-user: hotfix: correct way of getting environment variables (#5622)
@pyup-bot: pyup: Scheduled weekly dependency update for week 16 (#5619)
@ericholscher: Release 3.4.2 (#5613)
@ericholscher: Add explicit egg version to unicode-slugify (#5612)
@dojutsu-user: Remove ProxyMiddleware (#5607)
@dojutsu-user: Remove ‘Versions’ tab from Admin Dashboard. (#5600)
@dojutsu-user: Notify the user when deleting a superproject (#5596)
@saadmk11: Handle 401, 403 and 404 when setting up webhooks (#5589)
@saadmk11: Unify usage of settings and remove the usage of getattr for settings (#5588)
@saadmk11: Note about admin page in the docs (#5585)
@humitos: Remove USE_SETUPTOOLS_LATEST feature flag (#5578)
@saadmk11: Validate docs dir before writing custom js (#5569)
@rshrc: Added note in YAML docs (#5565)
@shivanshu1234: Specify python3 in installation instructions. (#5552)
@davidfischer: Write build artifacts to (cloud) storage from build servers (#5549)
@saadmk11: “Default branch: latest” does not exist Fix. (#5547)
@dojutsu-user: Update readthedocs-environment.json file when env vars are added/deleted (#5540)
@humitos: Update common to its latest version (#5517)
@saadmk11: Profile page performance issue Fix (#5472)
@stsewd: Remove unused form (#5443)
@stsewd: Use relative paths in config module (#5377)
@humitos: Initial structure for APIv3 (#5356)
@stsewd: Add models for automation rules (#5323)
@stsewd: Downgrade pytest-django (#5294)
@ericholscher: Add search for DomainData objects (#5290)
@gorshunovr: Change version references to :latest tag (#5245)
@dojutsu-user: Fix buttons problems in ‘Change Email’ section. (#5219)

Version 3.4.2¶

Date: April 22, 2019

@ericholscher: Add explicit egg version to unicode-slugify (#5612)
@saadmk11: Update Environmental Variable character limit (#5597)
@davidfischer: Add meta descriptions to top documentation (#5593)
@stsewd: Ignore pytest-xdist from pyupdate (#5590)
@saadmk11: Note about admin page in the docs (#5585)
@pyup-bot: pyup: Scheduled weekly dependency update for week 14 (#5580)
@stsewd: Use downloads.html in template (#5579)
@ihnorton: Fix typo in conda.rst (#5576)
@davidfischer: Fix for Firefox to close the ad correctly (#5571)
@davidfischer: Non mobile fixed footer ads (#5567)
@ericholscher: Release 3.4.1 (#5566)
@dojutsu-user: Update readthedocs-environment.json file when env vars are added/deleted (#5540)
@stsewd: Allow build mkdocs outside root (#5539)
@saadmk11: Sitemap assumes that all versions are translated Fix. (#5535)
@saadmk11: Remove Header Login button from login page (#5534)
@davidfischer: Optimize database performance of the footer API (#5530)
@stsewd: Don’t depend of enabled pdf/epub to show downloads (#5502)
@saadmk11: Don’t allow to create subprojects with same alias (#5404)
@saadmk11: Improve project translation listing Design under admin tab (#5380)

Version 3.4.1¶

Date: April 03, 2019

@pyup-bot: pyup: Scheduled weekly dependency update for week 13 (#5558)
@stsewd: Fix advanced settings form (#5544)
@stsewd: Call mkdocs using -m (#5542)
@stsewd: Allow build mkdocs outside root (#5539)
@stsewd: Use patch method to update has_valid_clone (#5538)
@pyup-bot: pyup: Scheduled weekly dependency update for week 12 (#5536)
@saadmk11: Sitemap assumes that all versions are translated Fix. (#5535)
@saadmk11: Remove Header Login button from login page (#5534)
@stevepiercy: Add pylons-sphinx-themes to list of supported themes (#5533)
@davidfischer: Optimize database performance of the footer API (#5530)
@stsewd: Fix extra origin in urls (#5523)
@davidjb: Update contributing docs for RTD’s own docs (#5522)
@davidjb: Use HTTPS for intersphinx mappings (#5521)
@davidjb: Fix formatting for CentOS/RHEL installs (#5520)
@davidfischer: Guide users to the YAML config from the build detail page (#5519)
@davidjb: Add to and reorder GitHub webhook docs (#5514)
@stsewd: Link to the docdir of the remote repo in non-rtd themes for mkdocs (#5513)
@stevepiercy: Tidy up grammar, promote Unicode characters (#5511)
@stsewd: Catch specific exception for config not found (#5510)
@dojutsu-user: Use ValueError instead of InvalidParamsException (#5509)
@humitos: Force Sphinx to not use xindy (#5507)
@stsewd: Update mkdocs (#5505)
@stsewd: Don’t depend of enabled pdf/epub to show downloads (#5502)
@ericholscher: Remove search & API from robots.txt (#5501)
@saadmk11: Make /random/ path work (#5496)
@humitos: Typo on conf.py.tmpl (#5495)
@rshrc: Added note warning about using sqlite 3.26.0 in development (#5491)
@stsewd: Regroup advanced settings (#5489)
@ericholscher: Fix bug that caused search objects not to delete (#5487)
@ericholscher: Release 3.4.0 (#5486)
@davidfischer: Promote the YAML config (#5485)
@pyup-bot: pyup: Scheduled weekly dependency update for week 11 (#5483)
@saadmk11: Dashboard screen performance fix (#5471)
@saadmk11: Build List Screen Performance Issue Fix. (#5470)
@saadmk11: Remove Haystack reference in Docs (#5469)
@davidfischer: Enable Django Debug Toolbar in development (#5464)
@davidfischer: Optimize the version list screen (#5460)
@stsewd: Regroup settings (#5459)
@humitos: Guide to build PDF for non-ASCII language (#5453)
@dojutsu-user: Remove asserts from code. (#5452)
@davidfischer: Optimize the repos API query (#5451)
@stsewd: Update version of setuptools (#5450)
@stsewd: Remove unused validator (#5442)
@humitos: Build PDF files using latexmk (#5437)
@stsewd: Always update the commit of the stable version (#5421)
@stsewd: Share doctree between builders (#5407)
@stsewd: Remove unused template (#5401)
@orlnub123: Fix pip installs (#5386)
@davidfischer: Add an application form for community ads (#5379)

Version 3.4.0¶

Date: March 18, 2019

@davidfischer: Promote the YAML config (#5485)
@saadmk11: Dashboard screen performance fix (#5471)
@saadmk11: Build List Screen Performance Issue Fix. (#5470)
@saadmk11: Remove Haystack reference in Docs (#5469)
@mashrikt: gitignore dev.db-journal file #5463 (#5466)
@davidfischer: Enable Django Debug Toolbar in development (#5464)
@davidfischer: Optimize the version list screen (#5460)
@stsewd: Regroup settings (#5459)
@Mariatta: Fix typo: leave the field black -> blank (#5457)
@stsewd: Use Ubuntu xenial on travis (#5456)
@dojutsu-user: Update links to point to stable version. (#5455)
@dojutsu-user: Fix inconsistency in footer links (#5454)
@davidfischer: Optimize the repos API query (#5451)
@stsewd: Update version of setuptools (#5450)
@stsewd: Remove unused validator (#5442)
@humitos: Build PDF files using latexmk (#5437)
@pyup-bot: pyup: Scheduled weekly dependency update for week 10 (#5432)
@shivanshu1234: Remove invalid example from v2.rst (#5430)
@saadmk11: Removed unused constant from core.models (#5424)
@stsewd: Fix reraise of exception (#5423)
@stsewd: Always update the commit of the stable version (#5421)
@stsewd: Fix warnings in code (#5419)
@stsewd: Refactor move_files (#5418)
@agarwalrounak: Document that people can create a version named stable (#5417)
@agarwalrounak: Update installation guide to include submodules (#5416)
@stsewd: Update docs for building with markdown (#5415)
@stsewd: Share doctree between builders (#5407)
@humitos: Communicate the project slug can be changed by requesting it (#5403)
@stsewd: Remove unused template (#5401)
@stsewd: Remove view docs dropdown (#5400)
@humitos: Minimum upgrade of the builds docs (#5398)
@stsewd: Update internal requirements (#5396)
@pyup-bot: pyup: Scheduled weekly dependency update for week 09 (#5395)
@dojutsu-user: Trigger build on default branch when saving a project (#5393)
@Mike-Dai: Removed un-needed python dependencies (#5389)
@orlnub123: Fix pip installs (#5386)
@rshrc: Addressed Issue #5327 (#5383)
@ericholscher: Be extra explicit about the CNAME (#5382)
@stsewd: Better MkDocs integration as GSoC idea (#5378)
@ericholscher: Release 3.3.1 (#5376)
@ericholscher: Add a GSOC section for openAPI (#5375)
@dojutsu-user: Make ‘default_version` field as readonly if no active versions are found. (#5374)
@ericholscher: Be more defensive with our storage uploading (#5371)
@ericholscher: Check for two paths for each file (#5370)
@ericholscher: Don’t show projects in Sphinx Domain Admin sidebar (#5367)
@stsewd: Start building with sphinx 1.8 (#5366)
@saadmk11: Remove pytest warnings (#5346)
@davidfischer: Remove the v1 API (#5293)
@stsewd: Remove doctype from resolver (#5230)
@humitos: Implementation of APIv3 (#4863)

Version 3.3.1¶

Date: February 28, 2019

@ericholscher: Be more defensive with our storage uploading (#5371)
@ericholscher: Check for two paths for each file (#5370)
@stsewd: Protect against anchors with # (#5369)
@ericholscher: Don’t show projects in Sphinx Domain Admin sidebar (#5367)
@ericholscher: Fix sphinx domain models and migrations (#5363)
@stsewd: Try to put back codecov integration (#5362)
@ericholscher: Release 3.3.0 (#5361)
@ericholscher: Fix search bug when an empty list of objects_id was passed (#5357)
@dojutsu-user: Add admin methods for reindexing versions from project and version admin. (#5343)
@stsewd: Cleanup a little of documentation_type from footer (#5315)
@ericholscher: Add modeling for intersphinx data (#5289)
@stsewd: Remove doctype from resolver (#5230)
@stsewd: Validate webhook’s payload (#4940)
@stsewd: Start testing config v2 on our project (#4838)
@ericholscher: Revert “Merge pull request #4636 from readthedocs/search_upgrade” (#4716)
@safwanrahman: [GSoC 2018] All Search Improvements (#4636)
@stsewd: Add schema for configuration file with yamale (#4084)
@stsewd: Add note about mercurial on tests (#3358)

Version 3.3.0¶

Date: February 27, 2019

@ericholscher: Fix search bug when an empty list of objects_id was passed (#5357)
@agjohnson: Update UI translations (#5354)
@ericholscher: Update GSOC page to mention we’re accepted. (#5353)
@pyup-bot: pyup: Scheduled weekly dependency update for week 08 (#5352)
@dojutsu-user: Increase path’s max_length for ImportedFile model to 4096 (#5345)
@saadmk11: improvement on inserting mkdocs media (#5344)
@dojutsu-user: Add admin methods for reindexing versions from project and version admin. (#5343)
@stsewd: Initialize local variable before using it (#5342)
@dojutsu-user: Remove deprecated code (#5341)
@stsewd: Require conda.file when using conda in v1 (#5338)
@stsewd: Remove unused setting (#5336)
@stsewd: Fix comment (#5329)
@stsewd: Don’t depend on specific data when catching exception (#5326)
@regisb: Fix “clean_builds” command argument parsing (#5320)
@stsewd: Cleanup a little of documentation_type from footer (#5315)
@humitos: Warning note about running ES locally for tests (#5314)
@humitos: Update documentation on running test for python environment (#5313)
@ericholscher: Release 3.2.3 (#5312)
@ericholscher: Add basic auth to the generic webhook API. (#5311)
@ericholscher: Fix an issue where we were not properly filtering projects (#5309)
@stsewd: Rstrip repo url (#5308)
@rexzing: Incompatible dependency for prospector with pylint-django (#5306)
@davidfischer: Allow extensions to control URL structure (#5296)
@stsewd: Downgrade pytest-django (#5294)
@ericholscher: Add modeling for intersphinx data (#5289)
@ovc: Tweek css for sphinx_prompt (#5281)
@saadmk11: #4036 Updated build list to include an alert state (#5222)
@humitos: Use unicode-slugify to generate Version.slug (#5186)
@dojutsu-user: Add admin functions for wiping a version (#5140)
@humitos: Generate general sitemap.xml for projects (#5122)
@humitos: Logging exceptions rework (#5118)
@davidfischer: Store ePubs and PDFs in media storage (#4947)
@stsewd: Validate webhook’s payload (#4940)
@ericholscher: Revert “Merge pull request #4636 from readthedocs/search_upgrade” (#4716)
@safwanrahman: [GSoC 2018] All Search Improvements (#4636)

Version 3.2.3¶

Date: February 19, 2019

@ericholscher: Add basic auth to the generic webhook API. (#5311)
@ericholscher: Fix an issue where we were not properly filtering projects (#5309)
@stsewd: Rstrip repo url (#5308)
@stsewd: Use autosectionlabel for docs in security (#5307)
@rexzing: Incompatible dependency for prospector with pylint-django (#5306)
@pyup-bot: pyup: Scheduled weekly dependency update for week 07 (#5305)
@davidfischer: Allow extensions to control URL structure (#5296)
@stsewd: Downgrade pytest-django (#5294)
@rexzing: Docs reformatting with :guilabel: (#5161)

Version 3.2.2¶

Date: February 13, 2019

@ericholscher: Support old jquery where responseJSON doesn’t exist (#5285)
@humitos: pyup.yml syntax fixed (#5284)
@dojutsu-user: Fix error of travis (rename migration file) (#5282)
@humitos: pyup YAML configuration file (#5279)
@pyup-bot: Pin ipdb to latest version 0.11 (#5278)
@pyup-bot: Pin datadiff to latest version 2.0.0 (#5277)
@pyup-bot: Pin pytest-cov to latest version 2.6.1 (#5276)
@pyup-bot: Pin pillow to latest version 5.4.1 (#5275)
@pyup-bot: Update elasticsearch to 6.3.1 (#5274)
@discdiver: clarify github integration needs https:// prepended (#5273)
@humitos: Setup and configure pyup.io (#5272)
@humitos: Update all Python dependencies (#5269)
@davidfischer: Add note about security issue (#5263)
@ericholscher: Don’t delay search delete on project delete (#5262)
@agjohnson: Automate docs version from our setup.cfg (#5259)
@agjohnson: Add admin actions for building versions (#5255)
@ericholscher: Give the 404 page a title. (#5252)
@humitos: Make our SUFFIX default selection py2/3 compatible (#5251)
@ericholscher: Release 3.2.1 (#5248)
@ericholscher: Remove excluding files on search. (#5246)
@gorshunovr: Change version references to :latest tag (#5245)
@humitos: Remove py2 compatibility (#5241)
@stsewd: Allow to override trigger_build from demo project (#5236)
@ericholscher: Change some info logging to debug to clean up build output (#5233)
@stsewd: Fake auth middleware in tests (#5206)
@EJEP: Clarify ‘more info’ link in admin settings page (#5180)
@rexzing: Docs reformatting with :guilabel: (#5161)

Version 3.2.1¶

Date: February 07, 2019

@ericholscher: Remove excluding files on search. (#5246)
@ericholscher: Don’t update search on HTMLFile save (#5244)
@ericholscher: Be more defensive in our 404 handler (#5243)
@humitos: Install sphinx-notfound-page for building 404.html custom page (#5242)
@humitos: Remove py2 compatibility (#5241)
@ericholscher: Release 3.2.0 (#5240)

Version 3.2.0¶

Date: February 06, 2019

@ericholscher: Support passing an explicit index_name for search indexing (#5239)
@davidfischer: Tweak some ad styles (#5237)
@stsewd: Fix conda issue link (#5226)
@humitos: Add Santos to the development team (#5224)
@ericholscher: Update our GSOC page for 2019 (#5210)
@humitos: Do not allow to merge ‘Status: blocked’ PRs (#5205)
@stsewd: Inject user to middleware tests (#5203)
@ericholscher: Remove approvals requirement from mergeable (#5200)
@agjohnson: Update project notification copy to past tense (#5199)
@stsewd: Remove feature flag for v2 (#5198)
@ericholscher: Refactor search code (#5197)
@stsewd: Update mergeable settings to v2 (#5196)
@stsewd: Fix mergeable bot (#5195)
@stsewd: Fix broken links for badges (#5190)
@dojutsu-user: Change badge style (#5189)
@humitos: Allow source_suffix to be a dictionary (#5183)
@humitos: Upgrade all packages removing py2 compatibility (#5179)
@dojutsu-user: Small docs fix (#5176)
@stsewd: Sync all services even if one social accoun fails (#5171)
@ericholscher: Release 3.1.0 (#5170)
@rvmzes: SyntaxError caused by comma in python3 (#5156)
@humitos: Use latest docker images as default (#5155)
@stsewd: Remove logic for guessing slug from an unregistered domain (#5143)
@humitos: Allow custom 404.html on projects (#5130)
@dojutsu-user: Docs for feature flag (#5043)
@stsewd: Remove usage of project.documentation_type in tasks (#4896)
@ericholscher: Reapply the Elastic Search upgrade to master (#4722)
@stsewd: Config file v2 docs (#4451)
@stsewd: Set python3 as default interpreter (#3581)

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

@ericholscher: Fix docs build (#5164)
@ericholscher: Release 3.0.0 (#5163)
@stsewd: Fix tests on master (#5162)
@dojutsu-user: Sort versions smartly everywhere (#5157)
@stsewd: Allow query params in redirects (#5081)
@dojutsu-user: Implement get objects or log (#4900)
@stsewd: Remove usage of project.documentation_type in tasks (#4896)
@ericholscher: Reapply the Elastic Search upgrade to master (#4722)

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

@stsewd: Fix tests on master (#5162)
@dojutsu-user: Sort versions smartly everywhere (#5157)
@rvmzes: SyntaxError caused by comma in python3 (#5156)
@ericholscher: Fix Sphinx conf.py inserts (#5150)
@ericholscher: Upgrade recommonmark to latest and fix integration (#5146)
@stsewd: Fix requirements for local installation (#5138)
@ericholscher: Fix local-docs-build requirements (#5136)
@humitos: Upgrade all dependencies (#5134)
@humitos: Configuration file for ProBot Mergeable Bot (#5132)
@xavfernandez: docs: fix integration typos (#5128)
@Hamdy722: Update LICENSE (#5125)
@stsewd: Remove doctype from search (#5121)
@humitos: Validate mkdocs.yml config on values that we manipulate (#5119)
@humitos: Use 2019 in our README (#5117)
@stsewd: Remove dead code from config module (#5116)
@ericholscher: Check that the repo exists before trying to get a git commit (#5115)
@ericholscher: Release 2.8.5 (#5111)
@stsewd: Use the python path from virtualenv in Conda (#5110)
@humitos: Feature flag to use readthedocs/build:testing image (#5109)
@stsewd: Use python from virtualenv’s bin directory when executing commands (#5107)
@dojutsu-user: Split requirements/pip.txt (#5100)
@humitos: Do not list banned projects under /projects/ (#5097)
@humitos: Do not build projects from banned users (#5096)
@humitos: Support custom robots.txt (#5086)
@stsewd: Allow query params in redirects (#5081)
@davidfischer: Fire a signal for domain verification (eg. for SSL) (#5071)
@humitos: Upgrade all code to be Python3 only (#5065)
@dojutsu-user: Use default settings for Config object (#5056)
@agjohnson: Allow large form posts via multipart encoded forms to command API (#5000)
@dojutsu-user: Validate url from webhook notification (#4983)
@dojutsu-user: Display error, using inbuilt notification system, if primary email is not verified (#4964)
@dojutsu-user: Implement get objects or log (#4900)
@humitos: CRUD for EnvironmentVariables from Project’s admin (#4899)
@stsewd: Remove usage of project.documentation_type in tasks (#4896)
@dojutsu-user: Fix the failing domain deletion task (#4891)
@stsewd: Remove unused validations from v1 config (#4883)
@humitos: Appropriate logging when a LockTimeout for VCS is reached (#4804)
@stsewd: Implement extended install option (#4740)
@bansalnitish: Added a link to open new issue with prefilled details (#3683)

Version 2.8.5¶

Date: January 15, 2019

@stsewd: Use the python path from virtualenv in Conda (#5110)
@humitos: Feature flag to use readthedocs/build:testing image (#5109)
@stsewd: Use python from virtualenv’s bin directory when executing commands (#5107)
@humitos: Do not build projects from banned users (#5096)
@agjohnson: Fix common pieces (#5095)
@rainwoodman: Suppress progress bar of the conda command. (#5094)
@humitos: Remove unused suggestion block from 404 pages (#5087)
@humitos: Remove header nav (Login/Logout button) on 404 pages (#5085)
@stsewd: Fix little typo (#5084)
@agjohnson: Split up deprecated view notification to GitHub and other webhook endpoints (#5083)
@humitos: Install ProBot (#5082)
@stsewd: Update docs about contributing to docs (#5077)
@humitos: Declare and improve invoke tasks (#5075)
@davidfischer: Fire a signal for domain verification (eg. for SSL) (#5071)
@agjohnson: Update copy on notifications for github services deprecation (#5067)
@humitos: Upgrade all packages with pur (#5059)
@dojutsu-user: Reduce logging to sentry (#5054)
@discdiver: fixed missing apostrophe for possessive “project’s” (#5052)
@dojutsu-user: Template improvements in “gold/subscription_form.html” (#5049)
@merwok: Fix link in features page (#5048)
@stsewd: Update webhook docs (#5040)
@stsewd: Remove sphinx static and template dir (#5039)
@stephenfin: Add temporary method for disabling shallow cloning (#5031) (#5036)
@stsewd: Raise exception in failed checkout (#5035)
@dojutsu-user: Change default_branch value from Version.slug to Version.identifier (#5034)
@humitos: Make wipe view not CSRF exempt (#5025)
@humitos: Convert an IRI path to URI before setting as NGINX header (#5024)
@safwanrahman: index project asynchronously (#5023)
@stsewd: Keep command output when it’s killed (#5015)
@stsewd: More hints for invalid submodules (#5012)
@ericholscher: Release 2.8.4 (#5011)
@stsewd: Remove auto doctype (#5010)
@davidfischer: Tweak sidebar ad priority (#5005)
@stsewd: Replace git status and git submodules status for gitpython (#5002)
@davidfischer: Backport jquery 2432 to Read the Docs (#5001)
@stsewd: Refactor remove_dir (#4994)
@humitos: Skip builds when project is not active (#4991)
@dojutsu-user: Make $ unselectable in docs (#4990)
@dojutsu-user: Remove deprecated “models.permalink” (#4975)
@dojutsu-user: Add validation for tags of length greater than 100 characters (#4967)
@dojutsu-user: Add test case for send_notifications on VersionLockedError (#4958)
@dojutsu-user: Remove trailing slashes on svn checkout (#4951)
@stsewd: Safe symlink on version deletion (#4937)
@humitos: CRUD for EnvironmentVariables from Project’s admin (#4899)
@humitos: Notify users about the usage of deprecated webhooks (#4898)
@dojutsu-user: Disable django guardian warning (#4892)
@humitos: Handle 401, 403 and 404 status codes when hitting GitHub for webhook (#4805)

Version 2.8.4¶

Date: December 17, 2018

@davidfischer: Tweak sidebar ad priority (#5005)
@davidfischer: Backport jquery 2432 to Read the Docs (#5001)
@ericholscher: Remove codecov comments and project coverage CI status (#4996)
@stsewd: Remove LOCAL_GIT_BRANCHES from settings (#4993)
@dojutsu-user: Link update on FAQ page (#4988)
@ericholscher: Only use remote branches for our syncing. (#4984)
@humitos: Sanitize output and chunk it at DATA_UPLOAD_MAX_MEMORY_SIZE (#4982)
@humitos: Modify DB field for container_time_limit to be an integer (#4979)
@dojutsu-user: Remove deprecated imports from “urlresolvers” (#4976)
@davidfischer: Workaround for a django-storages bug (#4963)
@ericholscher: Release 2.8.3 (#4961)
@monsij: Remove -e option (#4960)
@nutann3: Update “install Sphinx” URL (#4959)
@stsewd: Shallow git clone (#4939)
@dojutsu-user: Validate profile form fields (#4910)
@davidfischer: Calculate actual ad views (#4885)
@humitos: Allow all /api/v2/ CORS if the Domain is known (#4880)
@dojutsu-user: Disable django.security.DisallowedHost from logging (#4879)
@dojutsu-user: Remove ‘Sphinx Template Changes’ From Docs (#4878)
@dojutsu-user: Make form for adopting project a choice field (#4841)
@dojutsu-user: Add ‘Branding’ under the ‘Business Info’ section and ‘Guidelines’ on ‘Design Docs’ (#4830)
@dojutsu-user: Raise 404 at SubdomainMiddleware if the project does not exist. (#4795)
@dojutsu-user: Add help_text in the form for adopting a project (#4781)
@dojutsu-user: Remove /embed API endpoint (#4771)
@dojutsu-user: Improve unexpected error message when build fails (#4754)
@dojutsu-user: Change the way of using login_required decorator (#4723)
@dojutsu-user: Fix the form for adopting a project (#4721)

Version 2.8.3¶

Date: December 05, 2018

@nutann3: Update “install Sphinx” URL (#4959)
@humitos: Pin redis to the current stable and compatible version (#4956)
@humitos: Properly set LANG environment variables (#4954)
@humitos: Adapt code to remove and ignore warnings (#4953)
@stsewd: Shallow git clone (#4939)
@stsewd: Install latest version of pip (#4938)
@stsewd: Fix svn update (#4933)
@ericholscher: Release 2.8.2 (#4931)
@stsewd: Remove repeated and dead code (#4929)
@stsewd: Remove deprecated sudo from travis (#4919)
@dojutsu-user: Validate profile form fields (#4910)
@davidfischer: Calculate actual ad views (#4885)
@stsewd: Sync versions when creating/deleting versions (#4876)
@dojutsu-user: Remove unused project model fields (#4870)
@humitos: All package updates (#4792)
@humitos: Support git unicode branches (#4433)

Version 2.8.2¶

Date: November 28, 2018

@stsewd: Use .exists in queryset (#4927)
@stsewd: Don’t rmtree symlink (#4925)
@stsewd: Delete tags with same commit (#4915)
@safwanrahman: Tuning Elasticsearch for search improvements (#4909)
@edmondchuc: Fixed some typos. (#4906)
@humitos: Upgrade stripe Python package to the latest version (#4904)
@humitos: Retry on API failure when connecting from builders (#4902)
@stsewd: Separate update and checkout steps (#4901)
@humitos: Expose environment variables from database into build commands (#4894)
@ericholscher: Use python to expand the cwd instead of environment variables (#4882)
@humitos: Call Celery worker properly (#4881)
@dojutsu-user: Disable django.security.DisallowedHost from logging (#4879)
@dojutsu-user: Remove ‘Sphinx Template Changes’ From Docs (#4878)
@ericholscher: Unbreak the admin on ImportedFile by using raw_id_fields (#4874)
@stsewd: Check if latest exists before updating identifier (#4873)
@ericholscher: Release 2.8.1 (#4872)
@dojutsu-user: Update django-guardian settings (#4871)
@dojutsu-user: Change ‘VerisionLockedTimeout’ to ‘VersionLockedError’ in comment. (#4859)
@stsewd: Hide “edit on” when the version is a tag (#4851)
@stsewd: Delete untracked tags on fetch (#4811)
@humitos: Appropriate logging when a LockTimeout for VCS is reached (#4804)
@stsewd: Remove support for multiple configurations in one file (#4800)
@stsewd: Pipfile support (schema) (#4782)
@stsewd: Save config on build model (#4749)
@invinciblycool: Redirect to build detail post manual build (#4622)
@davidfischer: Enable timezone support and set timezone to UTC (#4545)
@chirathr: Webhook notification URL size validation check (#3680)

Version 2.8.1¶

Date: November 06, 2018

@ericholscher: Fix migration name on modified date migration (#4867)
@dojutsu-user: Change ‘VerisionLockedTimeout’ to ‘VersionLockedError’ in comment. (#4859)
@stsewd: Fix rtd config file (#4857)
@ericholscher: Shorten project name to match slug length (#4856)
@stsewd: Generic message for parser error of config file (#4853)
@stsewd: Use $HOME as CWD for virtualenv creation (#4852)
@stsewd: Hide “edit on” when the version is a tag (#4851)
@ericholscher: Add modified_date to ImportedFile. (#4850)
@ericholscher: Use raw_id_fields so that the Feature admin loads (#4849)
@stsewd: Allow to change project’s VCS (#4845)
@benjaoming: Version compare warning text (#4842)
@dojutsu-user: Make form for adopting project a choice field (#4841)
@humitos: Do not send notification on VersionLockedError (#4839)
@stsewd: Start testing config v2 on our project (#4838)
@ericholscher: Add all migrations that are missing from model changes (#4837)
@ericholscher: Add docstring to DrfJsonSerializer so we know why it’s there (#4836)
@ericholscher: Show the project’s slug in the dashboard (#4834)
@humitos: Avoid infinite redirection (#4833)
@ericholscher: Allow filtering builds by commit. (#4831)
@dojutsu-user: Add ‘Branding’ under the ‘Business Info’ section and ‘Guidelines’ on ‘Design Docs’ (#4830)
@davidfischer: Migrate old passwords without “set_unusable_password” (#4829)
@humitos: Do not import the Celery worker when running the Django app (#4824)
@damianz5: Fix for jQuery in doc-embed call (#4819)
@invinciblycool: Add MkDocsYAMLParseError (#4814)
@stsewd: Delete untracked tags on fetch (#4811)
@stsewd: Don’t activate version on build (#4810)
@humitos: Feature flag to make readthedocs theme default on MkDocs docs (#4802)
@ericholscher: Allow use of file:// urls in repos during development. (#4801)
@ericholscher: Release 2.7.2 (#4796)
@dojutsu-user: Raise 404 at SubdomainMiddleware if the project does not exist. (#4795)
@dojutsu-user: Add help_text in the form for adopting a project (#4781)
@humitos: Add VAT ID field for Gold User (#4776)
@sriks123: Remove logic around finding config file inside directories (#4755)
@dojutsu-user: Improve unexpected error message when build fails (#4754)
@stsewd: Don’t build latest on webhook if it is deactivated (#4733)
@dojutsu-user: Change the way of using login_required decorator (#4723)
@invinciblycool: Remove unused views and their translations. (#4632)
@invinciblycool: Redirect to build detail post manual build (#4622)
@anubhavsinha98: Issue #4551 Changed mock docks to use sphinx (#4569)
@xrmx: search: mark more strings for translation (#4438)
@Alig1493: Fix for issue #4092: Remove unused field from Project model (#4431)
@mashrikt: Remove pytest _describe (#4429)
@xrmx: static: use modern getJSON callbacks (#4382)
@jaraco: Script for creating a project (#4370)
@xrmx: make it easier to use a different default theme (#4278)
@humitos: Document alternate domains for business site (#4271)
@xrmx: restapi/client: don’t use DRF parser for parsing (#4160)
@julienmalard: New languages (#3759)
@stsewd: Improve installation guide (#3631)
@stsewd: Allow to hide version warning (#3595)
@Alig1493: [Fixed #872] Filter Builds according to commit (#3544)
@stsewd: Make slug field a valid DNS label (#3464)

Version 2.8.0¶

Date: October 30, 2018

Major change is an upgrade to Django 1.11.

@humitos: Cleanup old code (remove old_div) (#4817)
@humitos: Remove unnecessary migration (#4806)
@humitos: Feature flag to make readthedocs theme default on MkDocs docs (#4802)
@stsewd: Add codecov badge (#4799)
@humitos: Pin missing dependency for the MkDocs guide compatibility (#4798)
@ericholscher: Release 2.7.2 (#4796)
@humitos: Do not log as error a webhook with an invalid branch name (#4779)
@ericholscher: Run travis on release branches (#4763)
@ericholscher: Remove Eric & Anthony from ADMINS & MANAGERS settings (#4762)
@stsewd: Don’t use RequestsContext (#4759)
@davidfischer: Django 1.11 upgrade (#4750)
@stsewd: Dropdown to select Advanced Settings (#4710)
@stsewd: Remove hardcoded constant from config module (#4704)
@stsewd: Update tastypie (#4325)
@stsewd: Update to Django 1.10 (#4319)

Version 2.7.2¶

Date: October 23, 2018

@humitos: Validate the slug generated is valid before importing a project (#4780)
@humitos: Do not log as error a webhook with an invalid branch name (#4779)
@ericholscher: Add an index page to our design docs. (#4775)
@dojutsu-user: Remove /embed API endpoint (#4771)
@stsewd: Upgrade logs from debug on middleware (#4769)
@humitos: Link to SSL for Custom Domains fixed (#4766)
@ericholscher: Remove Eric & Anthony from ADMINS & MANAGERS settings (#4762)
@humitos: Do not re-raise the exception if the one that we are checking (#4761)
@humitos: Do not fail when unlinking an non-existing path (#4760)
@humitos: Allow to extend the DomainForm from outside (#4752)
@davidfischer: Fixes an OSX issue with the test suite (#4748)
@humitos: Use Docker time limit for max lock age (#4747)
@xyNNN: Fixed link of PagerDuty (#4744)
@davidfischer: Make storage syncers extend from a base class (#4742)
@ericholscher: Revert “Upgrade theme media to 0.4.2” (#4735)
@ericholscher: Upgrade theme media to 0.4.2 (#4734)
@stsewd: Extend install option from config file (v2, schema only) (#4732)
@stsewd: Remove /cname endpoint (#4731)
@ericholscher: Fix get_vcs_repo by moving it to the Mixin (#4727)
@humitos: Guide explaining how to keep compatibility with mkdocs (#4726)
@ericholscher: Release 2.7.1 (#4725)
@dojutsu-user: Fix the form for adopting a project (#4721)
@ericholscher: Remove logging verbosity on syncer failure (#4717)
@humitos: Lint requirement file for py2 (#4712)
@davidfischer: Improve the getting started docs (#4676)
@stsewd: Strict validation in configuration file (v2 only) (#4607)
@stsewd: Run coverage on travis (#4605)

Version 2.7.1¶

Date: October 04, 2018

@ericholscher: Revert “Merge pull request #4636 from readthedocs/search_upgrade” (#4716)
@ericholscher: Reduce the logging we do on CNAME 404 (#4715)
@davidfischer: Minor redirect admin improvements (#4709)
@humitos: Define the doc_search reverse URL from inside the __init__ on test (#4703)
@ericholscher: Revert “auto refresh false” (#4701)
@browniebroke: Remove unused package nilsimsa (#4697)
@stsewd: Fix broken url on sphinx projects (#4696)
@safwanrahman: Tuning elasticsearch shard and replica (#4689)
@ericholscher: Fix bug where we were not indexing Sphinx HTMLDir projects (#4685)
@ericholscher: Fix the queryset used in chunking (#4683)
@ericholscher: Fix python 2 syntax for getting first key in search index update (#4682)
@ericholscher: Release 2.7.0 (#4681)
@davidfischer: Increase footer ad text size (#4678)
@davidfischer: Fix broken docs links (#4677)
@ericholscher: Remove search autosync from tests so local tests work (#4675)
@stsewd: Refactor tasks into decorators (#4666)
@stsewd: Clean up logging (#4665)
@davidfischer: Ad customization docs (#4659)
@davidfischer: Fix a typo in the privacy policy (#4658)
@stsewd: Refactor PublicTask into a decorator task (#4656)
@stsewd: Remove -r option from update_repos command (#4653)
@davidfischer: Create an explicit ad placement (#4647)
@agjohnson: Use collectstatic on media/, without collecting user files (#4502)
@stsewd: Implement submodules key from v2 config (#4493)
@stsewd: Implement mkdocs key from v2 config (#4486)
@agjohnson: Add docs on our roadmap process (#4469)
@humitos: Send notifications when generic/unhandled failures (#3864)
@stsewd: Use relative path for docroot on mkdocs (#3525)

Version 2.7.0¶

Date: September 29, 2018

Reverted, do not use

Version 2.6.6¶

Date: September 25, 2018

@davidfischer: Fix a markdown test error (#4663)
@davidfischer: Ad customization docs (#4659)
@davidfischer: Fix a typo in the privacy policy (#4658)
@agjohnson: Put search step back into project build task (#4655)
@davidfischer: Create an explicit ad placement (#4647)
@stsewd: Fix some typos in docs and code (#4646)
@stsewd: Downgrade celery (#4644)
@stsewd: Downgrade django-taggit (#4639)
@safwanrahman: [Fix #4247] deleting old search code (#4635)
@stsewd: Add change versions slug to faq (#4633)
@stsewd: Pin sphinx to a compatible version (#4631)
@davidfischer: Make ads more obvious that they are ads (#4628)
@agjohnson: Change mentions of “CNAME” -> custom domain (#4627)
@invinciblycool: Use validate_dict for more accurate error messages (#4617)
@safwanrahman: fixing the indexing (#4615)
@humitos: Update our sponsors to mention Azure (#4614)
@agjohnson: Add cwd to subprocess calls (#4611)
@agjohnson: Make restapi URL additions conditional (#4609)
@agjohnson: Ability to use supervisor from python 2.7 and still run Python 3 (#4606)
@humitos: Return 404 for inactive versions and allow redirects on them (#4599)
@davidfischer: Fixes an issue with duplicate gold subscriptions (#4597)
@davidfischer: Fix ad block nag project issue (#4596)
@humitos: Run all our tests with Python 3.6 on Travis (#4592)
@humitos: Sanitize command output when running under DockerBuildEnvironment (#4591)
@humitos: Force resolver to use PUBLIC_DOMAIN over HTTPS if not Domain.https (#4579)
@davidfischer: Updates and simplification for mkdocs (#4556)
@humitos: Docs for hiding “On …” section from versions menu (#4547)
@stsewd: Implement sphinx key from v2 config (#4482)
@safwanrahman: [Fix #4268] Adding Documentation for upgraded Search (#4467)
@humitos: Upgrade all packages using pur (#4318)
@humitos: Clean CC sensible data on Gold subscriptions (#4291)
@stsewd: Update docs to match the new triague guidelines (#4260)
@xrmx: Make the STABLE and LATEST constants overridable (#4099)
@stsewd: Use str to get the exception message (#3912)

Version 2.6.5¶

Date: August 29, 2018

@stsewd: Tests for yaml file regex (#4587)
@agjohnson: Respect user language when caching homepage (#4585)
@humitos: Add start and termination to YAML file regex (#4584)
@safwanrahman: [Fix #4576] Do not delete projects which have multiple users (#4577)

Version 2.6.4¶

Date: August 29, 2018

@stsewd: Update tests failing on master (#4575)
@davidfischer: Add a flag to disable docsearch (#4570)
@stsewd: Fix nested syntax in docs (#4567)
@stsewd: Fix incorrect reraise (#4566)
@davidfischer: Add a note about specifying the version of build tools (#4562)
@davidfischer: Serve badges directly from local filesystem (#4561)
@humitos: Build JSON artifacts in HTML builder (#4554)
@humitos: Route task to proper queue (#4553)
@humitos: Sanitize BuildCommand.output by removing NULL characters (#4552)
@davidfischer: Fix changelog for 2.6.3 (#4548)
@ericholscher: Remove hiredis (#4542)
@davidfischer: Use the STATIC_URL for static files to avoid redirection (#4522)
@stsewd: Update docs about build process (#4515)
@StefanoChiodino: Allow for period as a prefix and yaml extension for config file (#4512)
@AumitLeon: Update information on mkdocs build process (#4508)
@humitos: Fix Exact Redirect to work properly when using $rest keyword (#4501)
@humitos: Mark some BuildEnvironmentError exceptions as Warning and do not log them (#4495)
@xrmx: projects: don’t explode trying to update UpdateDocsTaskStep state (#4485)
@humitos: Note with the developer flow to update our app translations (#4481)
@humitos: Add trimmed to all multilines blocktrans tags (#4480)
@humitos: Example and note with usage of trimmed option in blocktrans (#4479)
@humitos: Update Transifex resources for our documentation (#4478)
@humitos: Documentation for Manage Translations (#4470)
@stsewd: Port https://github.com/readthedocs/readthedocs-build/pull/38/ (#4461)
@stsewd: Match v1 config interface to new one (#4456)
@humitos: Skip tags that point to blob objects instead of commits (#4442)
@stsewd: Document python.use_system_site_packages option (#4422)
@humitos: More tips about how to reduce resources usage (#4419)
@xrmx: projects: user in ProjectQuerySetBase.for_admin_user is mandatory (#4417)

Version 2.6.3¶

Date: August 18, 2018

Release to Azure!

@davidfischer: Add Sponsors list to footer (#4424)
@stsewd: Cache node_modules to speed up CI (#4484)
@xrmx: templates: mark missing string for translation on project edit (#4518)
@ericholscher: Performance improvement: cache version listing on the homepage (#4526)
@agjohnson: Remove mailgun from our dependencies (#4531)
@davidfischer: Improved ad block detection (#4532)
@agjohnson: Revert “Remove SelectiveFileSystemFolder finder workaround” (#4533)
@davidfischer: Slight clarification on turning off ads for a project (#4534)
@davidfischer: Fix the sponsor image paths (#4535)
@agjohnson: Update build assets (#4537)

Version 2.6.2¶

Date: August 14, 2018

@davidfischer: Custom domain clarifications (#4514)
@trein: Use single quote throughout the file (#4513)
@davidfischer: Support ads on pallets themes (#4499)
@davidfischer: Only use HostHeaderSSLAdapter for SSL/HTTPS connections (#4498)
@keflavich: Very minor English correction (#4497)
@davidfischer: All static media is run through “collectstatic” (#4489)
@humitos: Fix reST structure (#4488)
@nijel: Document expected delay on CNAME change and need for CAA (#4487)
@davidfischer: Allow enforcing HTTPS for custom domains (#4483)
@davidfischer: Add some details around community ad qualifications (#4436)
@davidfischer: Updates to manifest storage (#4430)
@davidfischer: Update alt domains docs with SSL (#4425)
@agjohnson: Add SNI support for API HTTPS endpoint (#4423)
@davidfischer: API v1 cleanup (#4415)
@davidfischer: Allow filtering versions by active (#4414)
@mlncn: Fix broken link (#4410)
@safwanrahman: [Fix #4407] Port Project Search for Elasticsearch 6.x (#4408)
@davidfischer: Add client ID to Google Analytics requests (#4404)
@xrmx: projects: fix filtering in projects_tag_detail (#4398)
@davidfischer: Fix a proxy model bug related to ad-free (#4390)
@humitos: Release 2.6.1 (#4389)
@davidfischer: Do not access database from builds to check ad-free (#4387)
@humitos: Adapt YAML config integration tests (#4385)
@stsewd: Set full source_file path for default configuration (#4379)
@humitos: Make get_version usable from a specified path (#4376)
@humitos: More tags when logging errors to Sentry (#4375)
@humitos: Check for ‘options’ in update_repos command (#4373)
@safwanrahman: [Fix #4333] Implement asynchronous search reindex functionality using celery (#4368)
@stsewd: V2 of the configuration file (#4355)
@davidfischer: Remove the UID from the GA measurement protocol (#4347)
@humitos: Mount pip_cache_path in Docker container (#3556)
@agjohnson: Show subprojects in search results (#1866)

Version 2.6.1¶

Date: July 17, 2018

@davidfischer: Do not access database from builds to check ad-free (#4387)
@humitos: Adapt YAML config integration tests (#4385)
@stsewd: Set full source_file path for default configuration (#4379)
@humitos: More tags when logging errors to Sentry (#4375)

Version 2.6.0¶

Date: July 16, 2018

Adds initial support for HTTPS on custom domains
@stsewd: Revert “projects: serve badge with same protocol as site” (#4353)
@davidfischer: Do not overwrite sphinx context variables feature (#4349)
@stsewd: Calrify docs about how rtd select the stable version (#4348)
@davidfischer: Remove the UID from the GA measurement protocol (#4347)
@stsewd: Fix error in command (#4345)
@davidfischer: Improvements for the build/version admin (#4344)
@safwanrahman: [Fix #4265] Porting frontend docsearch to work with new API (#4340)
@ktdreyer: fix spelling of “demonstrating” (#4336)
@davidfischer: Warning about theme context implementation status (#4335)
@Blendify: Docs: Let Theme Choose Pygments Theme (#4331)
@davidfischer: Disable the ad block nag for ad-free projects (#4329)
@safwanrahman: [fix #4265] Port Document search API for Elasticsearch 6.x (#4309)
@stsewd: Refactor configuration object to class based (#4298)

Version 2.5.3¶

Date: July 05, 2018

@xrmx: Do less work in querysets (#4322)
@stsewd: Fix deprecations in management commands (#4321)
@davidfischer: Add a flag for marking a project ad-free (#4313)
@davidfischer: Use “npm run lint” from tox (#4312)
@davidfischer: Fix issues building static assets (#4311)
@humitos: Use PATHs to call clear_artifacts (#4296)
@safwanrahman: [Fix #2457] Implement exact match search (#4292)
@davidfischer: API filtering improvements (#4285)
@annegentle: Remove self-referencing links for webhooks docs (#4283)
@safwanrahman: [Fix #2328 #2013] Refresh search index and test for case insensitive search (#4277)
@xrmx: doc_builder: clarify sphinx backend append_conf docstring (#4276)
@davidfischer: Add documentation for APIv2 (#4274)
@humitos: Wrap notifications HTML code into a block (#4273)
@stsewd: Move config.py from rtd build (#4272)
@ericholscher: Fix our use of --use-wheel in pip. (#4269)
@agjohnson: Revert “Merge pull request #4206 from FlorianKuckelkorn/fix/pip-breaking-change” (#4261)
@humitos: Fix triggering a build for a skipped project (#4255)
@stsewd: Update default sphinx version (#4250)
@stsewd: Move config module from rtd-build repo (#4242)
@davidfischer: Allow staying logged in for longer (#4236)
@safwanrahman: Upgrade Elasticsearch to version 6.x (#4211)
@humitos: Make tests extensible from corporate site (#4095)
@stsewd: stable version stuck on a specific commit (#3913)

Version 2.5.2¶

Date: June 18, 2018

@davidfischer: Add a page detailing ad blocking (#4244)
@xrmx: projects: serve badge with same protocol as site (#4228)
@FlorianKuckelkorn: Fixed breaking change in pip 10.0.0b1 (2018-03-31) (#4206)
@StefanoChiodino: Document that readthedocs file can now have yaml extension (#4129)
@humitos: Downgrade docker to 3.1.3 because of timeouts in EXEC call (#4241)
@stsewd: Move parser tests from rtd-build repo (#4225)
@humitos: Handle revoked oauth permissions by the user (#4074)
@humitos: Allow to hook the initial build from outside (#4033)

Version 2.5.1¶

Date: June 14, 2018

@stsewd: Add feature to build json with html in the same build (#4229)
@davidfischer: Prioritize ads based on content (#4224)
@mostaszewski: #4170 - Link the version in the footer to the changelog (#4217)
@Jmennius: Add provision_elasticsearch command (#4216)
@SuriyaaKudoIsc: Use the latest YouTube share URL (#4209)
@davidfischer: Allow staff to trigger project builds (#4207)
@davidfischer: Use autosectionlabel in the privacy policy (#4204)
@davidfischer: These links weren’t correct after #3632 (#4203)
@davidfischer: Release 2.5.0 (#4200)
@ericholscher: Fix Build: Convert md to rst in docs (#4199)
@ericholscher: Updates to #3850 to fix merge conflict (#4198)
@ericholscher: Build on top of #3881 and put docs in custom_installs. (#4196)
@davidfischer: Increase the max theme version (#4195)
@ericholscher: Remove maxcdn reqs (#4194)
@ericholscher: Add missing gitignore item for ES testing (#4193)
@xrmx: fabfile: update i18n helpers (#4189)
@xrmx: Update italian locale (#4188)
@xrmx: locale: update and build the english translation (#4187)
@humitos: Upgrade celery to avoid AtributeError:async (#4185)
@stsewd: Prepare code for custo mkdocs.yaml location (#4184)
@agjohnson: Updates to our triage guidelines (#4180)
@davidfischer: Server side analytics (#4131)
@humitos: Upgrade packages with pur (#4124)
@stsewd: Fix resync remote repos (#4113)
@stsewd: Add schema for configuration file with yamale (#4084)
@davidfischer: Ad block nag to urge people to whitelist (#4037)
@benjaoming: Add Mexican Spanish as a project language (#3588)

Version 2.5.0¶

Date: June 06, 2018

@ericholscher: Fix Build: Convert md to rst in docs (#4199)
@ericholscher: Remove maxcdn reqs (#4194)
@ericholscher: Add missing gitignore item for ES testing (#4193)
@xrmx: fabfile: update i18n helpers (#4189)
@xrmx: Update italian locale (#4188)
@xrmx: locale: update and build the english translation (#4187)
@safwanrahman: Test for search functionality (#4116)
@davidfischer: Update mkdocs to the latest (#4041)
@davidfischer: Ad block nag to urge people to whitelist (#4037)
@davidfischer: Decouple the theme JS from readthedocs.org (#3968)
@xrmx: tests: fixup url tests in test_privacy_urls (#3966)
@fenilgandhi: Add support for different badge styles (#3632)
@benjaoming: Add Mexican Spanish as a project language (#3588)
@stsewd: Wrap versions’ list to look more consistent (#3445)
@agjohnson: Move CDN code to external abstraction (#2091)

Version 2.4.0¶

Date: May 31, 2018

This fixes assets that were generated against old dependencies in 2.3.14
@agjohnson: Fix issues with search javascript (#4176)
@stsewd: Use anonymous refs in CHANGELOG (#4173)
@stsewd: Fix some warnings on docs (#4172)
@davidfischer: Update the privacy policy date (#4171)
@davidfischer: Note about state and metro ad targeting (#4169)
@ericholscher: Add another guide around fixing memory usage. (#4168)
@stsewd: Download raw build log (#3585)
@stsewd: Add “edit” and “view docs” buttons to subproject list (#3572)
@kennethlarsen: Remove outline reset to bring back outline (#3512)

Version 2.3.14¶

Date: May 30, 2018

@ericholscher: Remove CSS override that doesn’t exist. (#4165)
@davidfischer: Include a DMCA request template (#4164)
@davidfischer: No CSRF cookie for docs pages (#4153)
@davidfischer: Small footer rework (#4150)
@stsewd: Fix prospector dependencies (#4149)
@ericholscher: Remove deploy directory which is unused. (#4147)
@stsewd: Use autosectionlabel extension (#4146)
@davidfischer: Add Intercom to the privacy policy (#4145)
@humitos: Minimum refactor to decide_if_cors (#4143)
@stsewd: Ignore migrations from coverage report (#4141)
@stsewd: 5xx status in old webhooks (#4139)
@davidfischer: Fix with Lato Bold font (#4138)
@davidfischer: Release 2.3.13 (#4137)
@davidfischer: Build static assets (#4136)
@xrmx: oauth/services: correct error handling in paginate (#4134)
@xrmx: oauth/services: don’t abuse log.exception (#4133)
@cedk: Use quiet mode to retrieve branches from mercurial (#4114)
@humitos: Add has_valid_clone and has_valid_webhook to ProjectAdminSerializer (#4107)
@stsewd: Put the rtd extension to the beginning of the list (#4054)
@stsewd: Use gitpython for tags (#4052)
@davidfischer: Do Not Track support (#4046)
@stsewd: Set urlconf to None after changing SUBDOMAIN setting (#4032)
@humitos: Fix /404/ testing page (#3976)
@xrmx: Fix some tests with postgres (#3958)
@xrmx: Fixup DJANGO_SETTINGS_SKIP_LOCAL in tests (#3899)
@xrmx: templates: mark a few more strings for translations (#3869)
@ze: Make search bar in dashboard have a more clear message. (#3844)
@varunotelli: Pointed users to Python3.6 (#3817)
@stsewd: [RDY] Fix tests for environment (#3764)
@ajatprabha: Ticket #3694: rename owners to maintainers (#3703)
@SanketDG: Refactor to replace old logging to avoid mangling (#3677)
@stsewd: Add rstcheck to CI (#3624)
@techtonik: Update Git on prod (#3615)
@stsewd: Allow to hide version warning (#3595)
@cclauss: Modernize Python 2 code to get ready for Python 3 (#3514)
@stsewd: Consistent version format (#3504)

Version 2.3.13¶

Date: May 23, 2018

@davidfischer: Build static assets (#4136)
@stsewd: Don’t sync _static dir for search builder (#4120)
@davidfischer: Use the latest Lato release (#4093)
@davidfischer: Update Gold Member marketing (#4063)
@davidfischer: Fix missing fonts (#4060)
@stsewd: Additional validation when changing the project language (#3790)
@stsewd: Improve yaml config docs (#3685)

Version 2.3.12¶

Date: May 21, 2018

@stsewd: Remove Django deprecation warning (#4112)
@davidfischer: Display feature flags in the admin (#4108)
@humitos: Set valid clone in project instance inside the version object also (#4105)
@davidfischer: Use the latest theme version in the default builder (#4096)
@humitos: Use next field to redirect user when login is done by social (#4083)
@humitos: Update the documentation_type when it’s set to ‘auto’ (#4080)
@brainwane: Update link to license in philosophy document (#4059)
@agjohnson: Update local assets for theme to 0.3.1 tag (#4047)
@stsewd: Fix unbalanced div (#4044)
@stsewd: Remove haystack from code base (#4039)
@davidfischer: Subdomains use HTTPS if settings specify (#3987)
@davidfischer: Draft Privacy Policy (#3978)
@humitos: Allow import Gitlab repo manually and set a webhook automatically (#3934)
@davidfischer: Enable ads on the readthedocs mkdocs theme (#3922)
@bansalnitish: Fixes #2953 - Url resolved with special characters (#3725)
@Jigar3: Deleted bookmarks app (#3663)

Version 2.3.11¶

Date: May 01, 2018

@agjohnson: Update local assets for theme to 0.3.1 tag (#4047)
@stsewd: Fix unbalanced div (#4044)
@stsewd: Remove haystack from code base (#4039)
@stsewd: Remove dead code from api v1 (#4038)
@humitos: Bump sphinx default version to 1.7.4 (#4035)
@davidfischer: Detail where ads are shown (#4031)
@ericholscher: Make email verification optional for dev (#4024)
@davidfischer: Support sign in and sign up with GH/GL/BB (#4022)
@agjohnson: Remove old varnish purge utility function (#4019)
@agjohnson: Remove build queue length warning on build list page (#4018)
@stsewd: Don’t check order on assertQuerysetEqual on tests for subprojects (#4016)
@stsewd: Tests for view docs api response (#4014)
@davidfischer: MkDocs projects use RTD’s analytics privacy improvements (#4013)
@humitos: Release 2.3.10 (#4009)
@davidfischer: Remove typekit fonts (#3982)
@stsewd: Move dynamic-fixture to testing requirements (#3956)
@stsewd: Fix view docs link (#3882)
@stsewd: [WIP] Remove comments app (#3802)
@Jigar3: Deleted bookmarks app (#3663)

Version 2.3.10¶

Date: April 24, 2018

@humitos: Downgrade docker to 3.1.3 (#4003)

Version 2.3.9¶

Date: April 20, 2018

@agjohnson: Fix recursion problem more generally (#3989)

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

@humitos: Fix server_error_500 path on single version (#3975)
@davidfischer: Fix bookmark app lint failures (#3969)
@humitos: Use latest setuptools (39.0.1) by default on build process (#3967)
@ericholscher: Fix exact redirects. (#3965)
@humitos: Make resolve_domain work when a project is subproject of itself (#3962)
@humitos: Remove django-celery-beat and use the default scheduler (#3959)
@xrmx: Fix some tests with postgres (#3958)
@davidfischer: Add advertising details docs (#3955)
@humitos: Use pur to upgrade python packages (#3953)
@ze: Make adjustments to Projects page (#3948)
@davidfischer: Small change to Chinese language names (#3947)
@agjohnson: Don’t share state in build task (#3946)
@davidfischer: Fixed footer ad width fix (#3944)
@humitos: Allow extend Translation and Subproject form logic from corporate (#3937)
@humitos: Resync valid webhook for project manually imported (#3935)
@humitos: Resync webhooks from Admin (#3933)
@humitos: Fix attribute order call (#3930)
@humitos: Mention RTD in the Project URL of the issue template (#3928)
@davidfischer: Correctly report mkdocs theme name (#3920)
@xrmx: Fixup DJANGO_SETTINGS_SKIP_LOCAL in tests (#3899)
@davidfischer: Show an adblock admonition in the dev console (#3894)
@stsewd: Fix view docs link (#3882)
@xrmx: templates: mark a few more strings for translations (#3869)
@ze: Update quickstart from README (#3847)
@vidartf: Fix page redirect preview (#3811)
@stsewd: [RDY] Fix requirements file lookup (#3800)
@aasis21: Documentation for build notifications using webhooks. (#3671)
@mashrikt: [#2967] Scheduled tasks for cleaning up messages (#3604)
@stsewd: Show URLS for exact redirect (#3593)
@marcelstoer: Doc builder template should check for mkdocs_page_input_path before using it (#3536)
@Code0x58: Document creation of slumber user (#3461)

Version 2.3.6¶

Date: April 05, 2018

@agjohnson: Drop readthedocs- prefix to submodule (#3916)
@agjohnson: This fixes two bugs apparent in nesting of translations in subprojects (#3909)
@humitos: Use new django celery beat scheduler (#3908)
@humitos: Use a proper default for docker attribute on UpdateDocsTask (#3907)
@davidfischer: Handle errors from publish_parts (#3905)
@agjohnson: Drop pdbpp from testing requirements (#3904)
@stsewd: Little improve on sync_versions (#3902)
@humitos: Save Docker image data in JSON file only for DockerBuildEnvironment (#3897)
@davidfischer: Single analytics file for all builders (#3896)
@humitos: Organize logging levels (#3893)

Version 2.3.5¶

Date: April 05, 2018

@agjohnson: Drop pdbpp from testing requirements (#3904)
@agjohnson: Resolve subproject correctly in the case of single version (#3901)
@davidfischer: Fixed footer ads again (#3895)
@davidfischer: Fix an Alabaster ad positioning issue (#3889)
@humitos: Save Docker image hash in RTD environment.json file (#3880)
@agjohnson: Add ref links for easier intersphinx on yaml config page (#3877)
@rajujha373: Typo correction in docs/features.rst (#3872)
@gaborbernat: add description for tox tasks (#3868)
@davidfischer: Another CORS hotfix for the sustainability API (#3862)
@agjohnson: Fix up some of the logic around repo and submodule URLs (#3860)
@davidfischer: Fix linting errors in tests (#3855)
@agjohnson: Use gitpython to find a commit reference (#3843)
@davidfischer: Remove pinned CSS Select version (#3813)
@davidfischer: Use JSONP for sustainability API (#3789)
@rajujha373: #3718: Added date to changelog (#3788)
@xrmx: tests: mock test_conf_file_not_found filesystem access (#3740)

Version 2.3.4¶

Release for static assets

Version 2.3.3¶

@davidfischer: Fix linting errors in tests (#3855)
@humitos: Fix linting issues (#3838)
@humitos: Update instance and model when record_as_success (#3831)
@ericholscher: Reorder GSOC projects, and note priority order (#3823)
@agjohnson: Add temporary method for skipping submodule checkout (#3821)
@davidfischer: Remove pinned CSS Select version (#3813)
@humitos: Use readthedocs-common to share linting files across different repos (#3808)
@davidfischer: Use JSONP for sustainability API (#3789)
@humitos: Define useful celery beat task for development (#3762)
@humitos: Auto-generate conf.py compatible with Py2 and Py3 (#3745)
@humitos: Task to remove orphan symlinks (#3543)
@stsewd: Fix regex for public bitbucket repo (#3533)
@humitos: Documentation for RTD context sent to the Sphinx theme (#3490)
@stsewd: Show link to docs on a build (#3446)

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¶

@humitos: Update instance and model when record_as_success (#3831)
@agjohnson: Bump docker -> 3.1.3 (#3828)
@Doug-AWS: Pip install note for Windows (#3827)
@himanshutejwani12: Update index.rst (#3824)
@ericholscher: Reorder GSOC projects, and note priority order (#3823)
@agjohnson: Autolint cleanup for #3821 (#3822)
@agjohnson: Add temporary method for skipping submodule checkout (#3821)
@stsewd: Pin astroid to fix linter issue on travis (#3816)
@varunotelli: Update install.rst dropped the Python 2.7 only part (#3814)
@xrmx: Update machine field when activating a version from project_version_detail (#3797)
@humitos: Allow members of “Admin” Team to wipe version envs (#3791)
@ericholscher: Add sustainability api to CORS (#3782)
@durwasa-chakraborty: Fixed a grammatical error (#3780)
@humitos: Trying to solve the end line character for a font file (#3776)
@stsewd: Fix tox env for coverage (#3772)
@bansalnitish: Added eslint rules (#3768)
@davidfischer: Use sustainability api for advertising (#3747)
@davidfischer: Add a sustainability API (#3672)
@humitos: Upgrade django-pagination to a “maintained” fork (#3666)
@humitos: Project updated when subproject modified (#3649)
@davidfischer: Anonymize IP addresses for Google Analytics (#3626)
@humitos: Improve “Sharing” docs (#3472)
@humitos: Upgrade docker-py to its latest version (docker==3.1.1) (#3243)
@humitos: Upgrade all packages using pur tool (#2916)
@rixx: Fix page redirect preview (#2711)

Version 2.3.0¶

Warning

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

@stsewd: Fix tox env for coverage (#3772)
@humitos: Try to fix end of file (#3761)
@berkerpeksag: Fix indentation in docs/faq.rst (#3758)
@stsewd: Check for http protocol before urlize (#3755)
@rajujha373: #3741: replaced Go Crazy text with Search (#3752)
@humitos: Log in the proper place and add the image name used (#3750)
@shubham76: Changed ‘Submit’ text on buttons with something more meaningful (#3749)
@agjohnson: Fix tests for Git submodule (#3737)
@bansalnitish: Add eslint rules and fix errors (#3726)
@davidfischer: Prevent bots indexing promos (#3719)
@agjohnson: Add argument to skip errorlist through knockout on common form (#3704)
@ajatprabha: Fixed #3701: added closing tag for div element (#3702)
@bansalnitish: Fixes internal reference (#3695)
@humitos: Always record the git branch command as success (#3693)
@ericholscher: Show the project slug in the project admin (to make it more explicit what project is what) (#3681)
@humitos: Upgrade django-taggit to 0.22.2 (#3667)
@stsewd: Check for submodules (#3661)
@agjohnson: Hotfix for adding logging call back into project sync task (#3657)
@agjohnson: Fix issue with missing setting in oauth SyncRepo task (#3656)
@ericholscher: Remove error logging that isn’t an error. (#3650)
@humitos: Project updated when subproject modified (#3649)
@aasis21: formatting buttons in edit project text editor (#3633)
@humitos: Filter by my own repositories at Import Remote Project (#3548)
@funkyHat: check for matching alias before subproject slug (#2787)

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.

@agjohnson: Hotfix for adding logging call back into project sync task (#3657)

@agjohnson: Fix issue with missing setting in oauth SyncRepo task (#3656)

@humitos: Tests for build notifications (#3654)

@humitos: Send proper context to celery email notification task (#3653)

@ericholscher: Remove error logging that isn’t an error. (#3650)

@davidfischer: Update RTD security docs (#3641)

@humitos: Ability to override the creation of the Celery App (#3623)

Version 2.2.0¶

@humitos: Tests for build notifications (#3654)

@humitos: Send proper context to celery email notification task (#3653)

@xrmx: Update django-formtools to 2.1 (#3648)

@xrmx: Update Django to 1.9.13 (#3647)

@davidfischer: Fix a 500 when searching for files with API v1 (#3645)

@davidfischer: Update RTD security docs (#3641)

@humitos: Fix SVN initialization for command logging (#3638)

@humitos: Ability to override the creation of the Celery App (#3623)

@humitos: Update the operations team (#3621)

@mohitkyadav: Add venv to .gitignore (#3620)

@stsewd: Remove hardcoded copyright year (#3616)

@stsewd: Improve installation steps (#3614)

@stsewd: Update GSOC (#3607)

@Jigar3: Updated AUTHORS.rst (#3601)

@stsewd: Pin less to latest compatible version (#3597)

@Angeles4four: Grammar correction (#3596)

@davidfischer: Fix an unclosed tag (#3592)

@aaksarin: add missed fontawesome-webfont.woff2 (#3589)

@davidfischer: Force a specific ad to be displayed (#3584)

@stsewd: Docs about preference for tags over branches (#3582)

@davidfischer: Rework homepage (#3579)

@stsewd: Don’t allow to create a subproject of a project itself (#3571)

@davidfischer: Fix for build screen in firefox (#3569)

@humitos: Style using pre-commit (#3560)

@humitos: Use DRF 3.1 pagination_class (#3559)

@davidfischer: Analytics fixes (#3558)

@davidfischer: Upgrade requests version (#3557)

@humitos: Mount pip_cache_path in Docker container (#3556)

@ericholscher: Add a number of new ideas for GSOC (#3552)

@humitos: Fix Travis lint issue (#3551)

@davidfischer: Send custom dimensions for mkdocs (#3550)

@davidfischer: Promo contrast improvements (#3549)

@humitos: Allow git tags with / in the name and properly slugify (#3545)

@humitos: Allow to import public repositories on corporate site (#3537)

@humitos: Log git checkout and expose to users (#3520)

@stsewd: Update docs (#3498)

@davidfischer: Switch to universal analytics (#3495)

@stsewd: Move Mercurial dependency to pip.txt (#3488)

@agjohnson: Add docs on removing edit button (#3479)

@davidfischer: Convert default dev cache to local memory (#3477)

@agjohnson: Fix lint error (#3402)

@techtonik: Fix Edit links if version is referenced by annotated tag (#3302)

@jaraco: Fixed build results page on firefox (part two) (#2630)

Version 2.1.6¶

@davidfischer: Promo contrast improvements (#3549)

@humitos: Refactor run command outside a Build and Environment (#3542)

@AnatoliyURL: Project in the local read the docs don’t see tags. (#3534)

@malarzm: searchtools.js missing init() call (#3532)

@johanneskoester: Build failed without details (#3531)

@danielmitterdorfer: “Edit on Github” points to non-existing commit (#3530)

@lk-geimfari: No such file or directory: ‘docs/requirements.txt’ (#3529)

@stsewd: Fix Good First Issue link (#3522)

@Blendify: Remove RTD Theme workaround (#3519)

@stsewd: Move project description to the top (#3510)

@davidfischer: Switch to universal analytics (#3495)

@davidfischer: Convert default dev cache to local memory (#3477)

@nlgranger: Github service: cannot unlink after deleting account (#3374)

@andrewgodwin: “stable” appearing to track future release branches (#3268)

@skddc: Add JSDoc to docs build environment (#3069)

@chummels: RTD building old “stable” docs instead of “latest” when auto-triggered from recent push (#2351)

@cajus: Builds get stuck in “Cloning” state (#2047)

@gossi: Cannot delete subproject (#1341)

@gigster99: extension problem (#1059)

Version 2.1.5¶

@ericholscher: Add GSOC 2018 page (#3518)

@stsewd: Move project description to the top (#3510)

@RichardLitt: Docs: Rename “Good First Bug” to “Good First Issue” (#3505)

@stsewd: Fix regex for getting project and user (#3501)

@ericholscher: Check to make sure changes exist in BitBucket pushes (#3480)

@andrewgodwin: “stable” appearing to track future release branches (#3268)

@cdeil: No module named pip in conda build (#2827)

@Yaseenh: building project does not generate new pdf with changes in it (#2758)

@chummels: RTD building old “stable” docs instead of “latest” when auto-triggered from recent push (#2351)

@KeithWoods: GitHub edit link is aggressively stripped (#1788)

Version 2.1.4¶

@davidfischer: Add programming language to API/READTHEDOCS_DATA (#3499)

@ericholscher: Remove our mkdocs search override (#3496)

@humitos: Better style (#3494)

@humitos: Update README.rst (#3492)

@davidfischer: Small formatting change to the Alabaster footer (#3491)

@matsen: Fixing “resetting” misspelling. (#3487)

@ericholscher: Add David to dev team listing (#3485)

@ericholscher: Check to make sure changes exist in BitBucket pushes (#3480)

@ericholscher: Use semvar for readthedocs-build to make bumping easier (#3475)

@davidfischer: Add programming languages (#3471)

@humitos: Remove TEMPLATE_LOADERS since it’s the default (#3469)

@Code0x58: Minor virtualenv upgrade (#3463)

@humitos: Remove invite only message (#3456)

@maxirus: Adding to Install Docs (#3455)

@stsewd: Fix a little typo (#3448)

@stsewd: Better autogenerated index file (#3447)

@stsewd: Better help text for privacy level (#3444)

@msyriac: Broken link URL changed fixes #3442 (#3443)

@ericholscher: Fix git (#3441)

@ericholscher: Properly slugify the alias on Project Relationships. (#3440)

@stsewd: Don’t show “build ideas” to unprivileged users (#3439)

@Blendify: Docs: Point Theme docs to new website (#3438)

@humitos: Do not use double quotes on git command with –format option (#3437)

@ericholscher: Hack in a fix for missing version slug deploy that went out a while back (#3433)

@humitos: Check versions used to create the venv and auto-wipe (#3432)

@ericholscher: Upgrade psycopg2 (#3429)

@humitos: Fix “Edit in Github” link (#3427)

@ericholscher: Add celery theme to supported ad options (#3425)

@humitos: Link to version detail page from build detail page (#3418)

@humitos: Move wipe button to version detail page (#3417)

@humitos: Show/Hide “See paid advertising” checkbox depending on USE_PROMOS (#3412)

@benjaoming: Strip well-known version component origin/ from remote version (#3377)

@humitos: Remove warnings from code (#3372)

@ericholscher: Add docker image from the YAML config integration (#3339)

@humitos: Show proper error to user when conf.py is not found (#3326)

@humitos: Simple task to finish inactive builds (#3312)

@techtonik: Fix Edit links if version is referenced by annotated tag (#3302)

@Riyuzakii: changed <strong> from html to css (#2699)

Version 2.1.3¶

date

Dec 21, 2017

@ericholscher: Upgrade psycopg2 (#3429)
@humitos: Fix “Edit in Github” link (#3427)
@ericholscher: Add celery theme to supported ad options (#3425)
@ericholscher: Only build travis push builds on master. (#3421)
@ericholscher: Add concept of dashboard analytics code (#3420)
@humitos: Use default avatar for User/Orgs in OAuth services (#3419)
@humitos: Link to version detail page from build detail page (#3418)
@humitos: Move wipe button to version detail page (#3417)
@bieagrathara: 019 497 8360 (#3416)
@bieagrathara: rew (#3415)
@tony: lint prospector task failing (#3414)
@humitos: Remove extra ‘s’ (#3413)
@humitos: Show/Hide “See paid advertising” checkbox depending on USE_PROMOS (#3412)
@accraze: Removing talks about RTD page (#3410)
@humitos: Pin pylint to 1.7.5 and fix docstring styling (#3408)
@agjohnson: Update style and copy on abandonment docs (#3406)
@agjohnson: Update changelog more consistently (#3405)
@agjohnson: Update prerelease invoke command to call with explicit path (#3404)
@ericholscher: Fix changelog command (#3403)
@agjohnson: Fix lint error (#3402)
@julienmalard: Recent builds are missing translated languages links (#3401)
@stsewd: Remove copyright application (#3400)
@humitos: Show connect buttons for installed apps only (#3394)
@agjohnson: Fix display of build advice (#3390)
@agjohnson: Don’t display the build suggestions div if there are no suggestions (#3389)
@ericholscher: Pass more data into the redirects. (#3388)
@ericholscher: Fix issue where you couldn’t edit your canonical domain. (#3387)
@benjaoming: Strip well-known version component origin/ from remote version (#3377)
@humitos: Remove warnings from code (#3372)
@JavaDevVictoria: Updated python.setup_py_install to be true (#3357)
@humitos: Use default avatars for GitLab/GitHub/Bitbucket integrations (users/organizations) (#3353)
@jonrkarr: Error in YAML configuration docs: default value for python.setup_py_install should be true (#3334)
@humitos: Show proper error to user when conf.py is not found (#3326)
@MikeHart85: Badges aren’t updating due to being cached on GitHub. (#3323)
@humitos: Simple task to finish inactive builds (#3312)
@techtonik: Fix Edit links if version is referenced by annotated tag (#3302)
@humitos: Remove/Update talks about RTD page (#3283)
@gawel: Regain pyquery project ownership (#3281)
@dialex: Build passed but I can’t see the documentation (maze screen) (#3246)
@makixx: Account is inactive (#3241)
@agjohnson: Cleanup misreported failed builds (#3230)
@cokelaer: links to github are broken (#3203)
@agjohnson: Remove copyright application (#3199)
@shacharoo: Unable to register after deleting my account (#3189)
@gtalarico: 3 week old Build Stuck Cloning (#3126)
@agjohnson: Regressions with conf.py and error reporting (#2963)
@agjohnson: Can’t edit canonical domain (#2922)
@virtuald: Documentation stuck in ‘cloning’ state (#2795)
@Riyuzakii: changed <strong> from html to css (#2699)
@tjanez: Support specifying ‘python setup.py build_sphinx’ as an alternative build command (#1857)
@bdarnell: Broken edit links (#1637)

Version 2.1.2¶

@agjohnson: Update changelog more consistently (#3405)

@agjohnson: Update prerelease invoke command to call with explicit path (#3404)

@agjohnson: Fix lint error (#3402)

@stsewd: Remove copyright application (#3400)

@humitos: Show connect buttons for installed apps only (#3394)

@agjohnson: Don’t display the build suggestions div if there are no suggestions (#3389)

@jonrkarr: Error in YAML configuration docs: default value for python.setup_py_install should be true (#3334)

@humitos: Simple task to finish inactive builds (#3312)

@agjohnson: Cleanup misreported failed builds (#3230)

@agjohnson: Remove copyright application (#3199)

Version 2.1.1¶

Release information missing

Version 2.1.0¶

@ericholscher: Revert “Merge pull request #3336 from readthedocs/use-active-for-stable” (#3368)

@agjohnson: Revert “Do not split before first argument (#3333)” (#3366)

@ericholscher: Remove pitch from ethical ads page, point folks to actual pitch page. (#3365)

@agjohnson: Add changelog and changelog automation (#3364)

@ericholscher: Fix mkdocs search. (#3361)

@ericholscher: Email sending: Allow kwargs for other options (#3355)

@ericholscher: Try and get folks to put more tags. (#3350)

@ericholscher: Suggest wiping your environment to folks with bad build outcomes. (#3347)

@humitos: GitLab Integration (#3327)

@jimfulton: Draft policy for claiming existing project names. (#3314)

@agjohnson: More logic changes to error reporting, cleanup (#3310)

@safwanrahman: [Fix #3182] Better user deletion (#3214)

@ericholscher: Better User deletion (#3182)

@RichardLitt: Add Needed: replication label (#3138)

@josejrobles: Replaced usage of deprecated function get_fields_with_model with new … (#3052)

@ericholscher: Don’t delete the subprojects directory on sync of superproject (#3042)

@andrew: Pass query string when redirecting, fixes #2595 (#3001)

@saily: Add GitLab repo sync and webhook support (#1870)

@destroyerofbuilds: Setup GitLab Web Hook on Project Import (#1443)

@takotuesday: Add GitLab Provider from django-allauth (#1441)

Version 2.0¶

@ericholscher: Email sending: Allow kwargs for other options (#3355)

@ericholscher: Try and get folks to put more tags. (#3350)

@ericholscher: Small changes to email sending to enable from email (#3349)

@dplanella: Duplicate TOC entries (#3345)

@ericholscher: Small tweaks to ethical ads page (#3344)

@agjohnson: Fix python usage around oauth pagination (#3342)

@tony: Fix isort link (#3340)

@ericholscher: Change stable version switching to respect active (#3336)

@ericholscher: Allow superusers to pass admin & member tests for projects (#3335)

@humitos: Do not split before first argument (#3333)

@humitos: Update docs for pre-commit (auto linting) (#3332)

@humitos: Take preferece of tags over branches when selecting the stable version (#3331)

@humitos: Add prospector as a pre-commit hook (#3328)

@andrewgodwin: “stable” appearing to track future release branches (#3268)

@humitos: Config files for auto linting (#3264)

@mekrip: Build is not working (#3223)

@skddc: Add JSDoc to docs build environment (#3069)

@jakirkham: Specifying conda version used (#2076)

@agjohnson: Document code style guidelines (#1475)

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¶

Updated Django from 1.6.11 to 1.8.3.
Removed South and ported the South migrations to Django’s migration framework.
Updated django-celery from 3.0.23 to 3.1.26 as django-celery 3.0.x does not support Django 1.8.
Updated Celery from 3.0.24 to 3.1.18 because we had to update django-celery. We need to test this extensively and might need to think about using the new Celery API directly and dropping django-celery. See release notes: https://docs.celeryproject.org/en/3.1/whatsnew-3.1.html
Updated tastypie from 0.11.1 to current master (commit 1e1aff3dd4dcd21669e9c68bd7681253b286b856) as 0.11.x is not compatible with Django 1.8. No surprises expected but we should ask for a proper release, see release notes: https://github.com/django-tastypie/django-tastypie/blob/master/docs/release_notes/v0.12.0.rst
Updated django-oauth from 0.16.1 to 0.21.0. No surprises expected, see release notes in the docs and finer grained in the repo
Updated django-guardian from 1.2.0 to 1.3.0 to gain Django 1.8 support. No surprises expected, see release notes: https://github.com/lukaszb/django-guardian/blob/devel/CHANGES
Using django-formtools instead of removed django.contrib.formtools now. Based on the Django release notes, these modules are the same except of the package name.
Updated pytest-django from 2.6.2 to 2.8.0. No tests required, but running the testsuite :smile:
Updated psycopg2 from 2.4 to 2.4.6 as 2.4.5 is required by Django 1.8. No trouble expected as Django is the layer between us and psycopg2. Also it’s only a minor version upgrade. Release notes: http://initd.org/psycopg/docs/news.html#what-s-new-in-psycopg-2-4-6
Added django.setup() to conf.py to load django properly for doc builds.
Added migrations for all apps with models in the readthedocs/ directory

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