Merge branch 'master' into subproject-alias

Author: saadmk11

.github/CONTRIBUTING.rst

@@ -1 +1 @@
-Please review our contributing documentation located at http://docs.readthedocs.org/en/latest/contribute.html
+Please review our contributing documentation located at https://docs.readthedocs.io/en/latest/contribute.html

.gitignore

@@ -62,3 +62,5 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+
+dev.db-journal

.travis.yml

@@ -1,6 +1,7 @@
 language: python
 python:
   - 3.6
+dist: xenial
 matrix:
   include:
     - python: 3.6
@@ -21,8 +22,6 @@ cache:
     - ~/.cache/pip
     - ~/.nvm/nvm.sh
     - ~/.npm
-before_install:
-  - sudo apt-get install -y git
 install:
   - ./scripts/travis/install_elasticsearch.sh
   - pip install tox-travis

CHANGELOG.rst

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

docs/.rstcheck.cfg

@@ -1,4 +1,4 @@
 [rstcheck]
-ignore_directives=automodule,http:get,tabs,tab,prompt
+ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post
 ignore_roles=djangosetting,setting,featureflags,buildpyversions
 ignore_messages=(Duplicate implicit target name: ".*")|(Hyperlink target ".*" is not referenced)

docs/advertising/advertising-details.rst

@@ -97,6 +97,7 @@ Currently we show ads on:
 * Sphinx theme provided by Read the Docs
 * MkDocs theme provided by Read the Docs (beginning in May 2018)
 * Alabaster Sphinx theme
+* [Pylons Sphinx Themes](https://github.com/Pylons/pylons-sphinx-themes), including pyramid, pylons, and pylonsfw.
 
 This list will expand as we strive to put advertising on a
 larger percentage of the documentation served by us.

docs/advertising/ethical-advertising.rst

@@ -125,7 +125,7 @@ Community Ads
 There are a large number of projects, conferences, and initiatives
 that we care about in the software and open source ecosystems.
 A large number of them operate like we did in the past, with almost no income.
-Our new Community Ads program will highlight some of these projects each month.
+Our Community Ads program will highlight some of these projects.
 
 There are a few qualifications for our Community Ads program:
 
@@ -138,9 +138,12 @@ There are a few qualifications for our Community Ads program:
   to one of our paid advertisers.
 
 We'll show 10% of our ad inventory each month to support initiatives that we care about.
-`Send us an email <mailto:[email protected]>`_ to be considered for our Community Ads program.
+Please `complete an application`_ to be considered for our Community Ads program.
+If you have any questions about our community ads program, feel free to
+`send us an email <mailto:[email protected]>`_.
 
 .. _OSI approved license: https://opensource.org/licenses
+.. _complete an application: https://docs.google.com/forms/d/e/1FAIpQLSdd9LDska1eiDHWHs4No-8AlqjDxsUuP_zSBTeYyl5tMcBeFQ/viewform?usp=sf_link
 
 
 Opting Out

docs/api/index.rst

@@ -5,22 +5,9 @@ This section of the documentation details the public API
 usable to get details of projects, builds, versions and other details
 from Read the Docs.
 
-.. warning::
-
-    Originally, the Read the Docs API allowed connections over insecure HTTP.
-    Starting in January 2019, requests over HTTP
-    will be automatically redirected to HTTPS
-    and non-GET/HEAD requests over insecure HTTP will fail.
-
-.. tip::
-
-    It is a good idea to put your email address, application name,
-    or Read the Docs username into the user agent header of your requests.
-    That way the Read the Docs' team can contact you in the event of issues.
 
 
 .. toctree::
     :maxdepth: 3
 
     v2
-    v1