Merge branch 'master' into fix-domain-deletion-task-sym

Author: dojutsu-user

.codecov.yml

@@ -1,2 +1,5 @@
-comment:
-  layout: "diff, files"
+comment: off
+coverage:
+  status:
+    project: off
+

.github/config.yml

@@ -0,0 +1,9 @@
+# ProBot TODO bot
+# https://probot.github.io/apps/todo/
+
+todo:
+  autoAssign: false
+  blobLines: 7
+  caseSensitive: true
+  keyword: "TODO"
+

.github/no-response.yml

@@ -0,0 +1,17 @@
+# ProBot No Response Bot
+# https://probot.github.io/apps/no-response/
+
+# Number of days of inactivity before an Issue is closed for lack of response
+daysUntilClose: 14
+
+# Label requiring a response
+responseRequiredLabel: 'Needed: more information'
+
+# Comment to post when closing an Issue for lack of response. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed because
+  [there has been no response to our request for more information](https://docs.readthedocs.io/en/latest/contribute.html#initial-triage)
+  from the original author. With only the information that is currently in the issue,
+  we don't have enough information to take action.
+  Please reach out if you have or find the answers we need so that we can investigate further.
+  Thanks!

.github/stale.yml

@@ -0,0 +1,26 @@
+# ProBot Stale Bot
+# https://probot.github.io/apps/stale/
+
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 45
+
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - 'Accepted'
+  - 'Needed: design decision'
+  - 'Status: blocked'
+
+# Label to use when marking an issue as stale
+staleLabel: 'Status: stale'
+
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.travis.yml

@@ -2,7 +2,6 @@ language: python
 python:
   - 2.7
   - 3.6
-sudo: false
 env:
   - ES_VERSION=1.3.9 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
 matrix:

CHANGELOG.rst

@@ -1,3 +1,91 @@
+Version 2.8.4
+-------------
+
+:Date: December 17, 2018
+
+* `@davidfischer <http://github.com/davidfischer>`__: Tweak sidebar ad priority (`#5005 <https://github.com/rtfd/readthedocs.org/pull/5005>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Backport jquery 2432 to Read the Docs (`#5001 <https://github.com/rtfd/readthedocs.org/pull/5001>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Remove codecov comments and project coverage CI status (`#4996 <https://github.com/rtfd/readthedocs.org/pull/4996>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove `LOCAL_GIT_BRANCHES` from settings (`#4993 <https://github.com/rtfd/readthedocs.org/pull/4993>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Link update on FAQ page (`#4988 <https://github.com/rtfd/readthedocs.org/pull/4988>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Only use remote branches for our syncing. (`#4984 <https://github.com/rtfd/readthedocs.org/pull/4984>`__)
+* `@humitos <http://github.com/humitos>`__: Sanitize output and chunk it at DATA_UPLOAD_MAX_MEMORY_SIZE (`#4982 <https://github.com/rtfd/readthedocs.org/pull/4982>`__)
+* `@humitos <http://github.com/humitos>`__: Modify DB field for container_time_limit to be an integer (`#4979 <https://github.com/rtfd/readthedocs.org/pull/4979>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove deprecated imports from "urlresolvers" (`#4976 <https://github.com/rtfd/readthedocs.org/pull/4976>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Workaround for a django-storages bug (`#4963 <https://github.com/rtfd/readthedocs.org/pull/4963>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Release 2.8.3 (`#4961 <https://github.com/rtfd/readthedocs.org/pull/4961>`__)
+* `@monsij <http://github.com/monsij>`__: Remove -e option (`#4960 <https://github.com/rtfd/readthedocs.org/pull/4960>`__)
+* `@nutann3 <http://github.com/nutann3>`__: Update "install Sphinx" URL (`#4959 <https://github.com/rtfd/readthedocs.org/pull/4959>`__)
+* `@stsewd <http://github.com/stsewd>`__: Shallow git clone (`#4939 <https://github.com/rtfd/readthedocs.org/pull/4939>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Validate profile form fields (`#4910 <https://github.com/rtfd/readthedocs.org/pull/4910>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Calculate actual ad views (`#4885 <https://github.com/rtfd/readthedocs.org/pull/4885>`__)
+* `@humitos <http://github.com/humitos>`__: Allow all /api/v2/ CORS if the Domain is known (`#4880 <https://github.com/rtfd/readthedocs.org/pull/4880>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Disable django.security.DisallowedHost from logging (`#4879 <https://github.com/rtfd/readthedocs.org/pull/4879>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove 'Sphinx Template Changes' From Docs (`#4878 <https://github.com/rtfd/readthedocs.org/pull/4878>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Make form for adopting project a choice field (`#4841 <https://github.com/rtfd/readthedocs.org/pull/4841>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Add 'Branding' under the 'Business Info' section and 'Guidelines' on 'Design Docs' (`#4830 <https://github.com/rtfd/readthedocs.org/pull/4830>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Raise 404 at SubdomainMiddleware if the project does not exist. (`#4795 <https://github.com/rtfd/readthedocs.org/pull/4795>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Add help_text in the form for adopting a project (`#4781 <https://github.com/rtfd/readthedocs.org/pull/4781>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove /embed API endpoint (`#4771 <https://github.com/rtfd/readthedocs.org/pull/4771>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Improve unexpected error message when build fails (`#4754 <https://github.com/rtfd/readthedocs.org/pull/4754>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Change the way of using login_required decorator (`#4723 <https://github.com/rtfd/readthedocs.org/pull/4723>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Fix the form for adopting a project (`#4721 <https://github.com/rtfd/readthedocs.org/pull/4721>`__)
+
+Version 2.8.3
+-------------
+
+:Date: December 05, 2018
+
+* `@nutann3 <http://github.com/nutann3>`__: Update "install Sphinx" URL (`#4959 <https://github.com/rtfd/readthedocs.org/pull/4959>`__)
+* `@humitos <http://github.com/humitos>`__: Pin redis to the current stable and compatible version (`#4956 <https://github.com/rtfd/readthedocs.org/pull/4956>`__)
+* `@humitos <http://github.com/humitos>`__: Properly set LANG environment variables (`#4954 <https://github.com/rtfd/readthedocs.org/pull/4954>`__)
+* `@humitos <http://github.com/humitos>`__: Adapt code to remove and ignore warnings (`#4953 <https://github.com/rtfd/readthedocs.org/pull/4953>`__)
+* `@stsewd <http://github.com/stsewd>`__: Shallow git clone (`#4939 <https://github.com/rtfd/readthedocs.org/pull/4939>`__)
+* `@stsewd <http://github.com/stsewd>`__: Install latest version of pip (`#4938 <https://github.com/rtfd/readthedocs.org/pull/4938>`__)
+* `@stsewd <http://github.com/stsewd>`__: Fix svn update (`#4933 <https://github.com/rtfd/readthedocs.org/pull/4933>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Release 2.8.2 (`#4931 <https://github.com/rtfd/readthedocs.org/pull/4931>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove repeated and dead code (`#4929 <https://github.com/rtfd/readthedocs.org/pull/4929>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove deprecated sudo from travis (`#4919 <https://github.com/rtfd/readthedocs.org/pull/4919>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Validate profile form fields (`#4910 <https://github.com/rtfd/readthedocs.org/pull/4910>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Calculate actual ad views (`#4885 <https://github.com/rtfd/readthedocs.org/pull/4885>`__)
+* `@stsewd <http://github.com/stsewd>`__: Sync versions when creating/deleting versions (`#4876 <https://github.com/rtfd/readthedocs.org/pull/4876>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove unused project model fields (`#4870 <https://github.com/rtfd/readthedocs.org/pull/4870>`__)
+* `@humitos <http://github.com/humitos>`__: All package updates (`#4792 <https://github.com/rtfd/readthedocs.org/pull/4792>`__)
+* `@humitos <http://github.com/humitos>`__: Support git unicode branches (`#4433 <https://github.com/rtfd/readthedocs.org/pull/4433>`__)
+
+Version 2.8.2
+-------------
+
+:Date: November 28, 2018
+
+* `@stsewd <http://github.com/stsewd>`__: Use .exists in queryset (`#4927 <https://github.com/rtfd/readthedocs.org/pull/4927>`__)
+* `@stsewd <http://github.com/stsewd>`__: Don't rmtree symlink (`#4925 <https://github.com/rtfd/readthedocs.org/pull/4925>`__)
+* `@stsewd <http://github.com/stsewd>`__: Delete tags with same commit (`#4915 <https://github.com/rtfd/readthedocs.org/pull/4915>`__)
+* `@safwanrahman <http://github.com/safwanrahman>`__: Tuning Elasticsearch for search improvements (`#4909 <https://github.com/rtfd/readthedocs.org/pull/4909>`__)
+* `@edmondchuc <http://github.com/edmondchuc>`__: Fixed some typos. (`#4906 <https://github.com/rtfd/readthedocs.org/pull/4906>`__)
+* `@humitos <http://github.com/humitos>`__: Upgrade stripe Python package to the latest version (`#4904 <https://github.com/rtfd/readthedocs.org/pull/4904>`__)
+* `@humitos <http://github.com/humitos>`__: Retry on API failure when connecting from builders (`#4902 <https://github.com/rtfd/readthedocs.org/pull/4902>`__)
+* `@stsewd <http://github.com/stsewd>`__: Separate update and checkout steps (`#4901 <https://github.com/rtfd/readthedocs.org/pull/4901>`__)
+* `@humitos <http://github.com/humitos>`__: Expose environment variables from database into build commands (`#4894 <https://github.com/rtfd/readthedocs.org/pull/4894>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Use python to expand the cwd instead of environment variables (`#4882 <https://github.com/rtfd/readthedocs.org/pull/4882>`__)
+* `@humitos <http://github.com/humitos>`__: Call Celery worker properly (`#4881 <https://github.com/rtfd/readthedocs.org/pull/4881>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Disable django.security.DisallowedHost from logging (`#4879 <https://github.com/rtfd/readthedocs.org/pull/4879>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove 'Sphinx Template Changes' From Docs (`#4878 <https://github.com/rtfd/readthedocs.org/pull/4878>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Unbreak the admin on ImportedFile by using raw_id_fields (`#4874 <https://github.com/rtfd/readthedocs.org/pull/4874>`__)
+* `@stsewd <http://github.com/stsewd>`__: Check if latest exists before updating identifier (`#4873 <https://github.com/rtfd/readthedocs.org/pull/4873>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Release 2.8.1 (`#4872 <https://github.com/rtfd/readthedocs.org/pull/4872>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Update django-guardian settings (`#4871 <https://github.com/rtfd/readthedocs.org/pull/4871>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Change 'VerisionLockedTimeout' to 'VersionLockedError' in comment. (`#4859 <https://github.com/rtfd/readthedocs.org/pull/4859>`__)
+* `@stsewd <http://github.com/stsewd>`__: Hide "edit on" when the version is a tag (`#4851 <https://github.com/rtfd/readthedocs.org/pull/4851>`__)
+* `@stsewd <http://github.com/stsewd>`__: Delete untracked tags on fetch (`#4811 <https://github.com/rtfd/readthedocs.org/pull/4811>`__)
+* `@humitos <http://github.com/humitos>`__: Appropiate logging when a LockTimeout for VCS is reached (`#4804 <https://github.com/rtfd/readthedocs.org/pull/4804>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove support for multiple configurations in one file (`#4800 <https://github.com/rtfd/readthedocs.org/pull/4800>`__)
+* `@stsewd <http://github.com/stsewd>`__: Pipfile support (schema) (`#4782 <https://github.com/rtfd/readthedocs.org/pull/4782>`__)
+* `@stsewd <http://github.com/stsewd>`__: Save config on build model (`#4749 <https://github.com/rtfd/readthedocs.org/pull/4749>`__)
+* `@invinciblycool <http://github.com/invinciblycool>`__: Redirect to build detail post manual build (`#4622 <https://github.com/rtfd/readthedocs.org/pull/4622>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Enable timezone support and set timezone to UTC (`#4545 <https://github.com/rtfd/readthedocs.org/pull/4545>`__)
+* `@chirathr <http://github.com/chirathr>`__: Webhook notification URL size validation check (`#3680 <https://github.com/rtfd/readthedocs.org/pull/3680>`__)
+
 Version 2.8.1
 -------------
 

common

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

docs/.rstcheck.cfg

@@ -0,0 +1,13 @@
+/* CSS for sphinx-prompt */
+
+pre.highlight {
+  border: 1px solid #e1e4e5;
+  overflow-x: auto;
+  margin: 1px 0 24px 0;
+  padding: 12px 12px;
+}
+
+pre.highlight span.prompt1 {
+  font-size: 12px;
+  line-height: 1.4;
+}

docs/_static/css/sphinx_prompt_css.css

@@ -53,9 +53,9 @@ Project list
 
     **Example request**:
 
-    .. sourcecode:: bash
+    .. prompt:: bash $
 
-        $ curl https://readthedocs.org/api/v2/project/?slug=pip
+        curl https://readthedocs.org/api/v2/project/?slug=pip
 
     **Example response**:
 
@@ -232,9 +232,9 @@ Build list
 
     **Example request**:
 
-    .. sourcecode:: bash
+    .. prompt:: bash $
 
-        $ curl https://readthedocs.org/api/v2/build/?project__slug=pip
+        curl https://readthedocs.org/api/v2/build/?project__slug=pip
 
     **Example response**:
 

docs/api/v2.rst

@@ -69,7 +69,7 @@ Understanding how Read the Docs builds your project will help you with debugging
 It should also allow you to take advantage of certain things that happen during the build process.
 
 The first step of the process is that we check out your code from the repository you have given us.
-If the code is already checked out, we update the copy to the branch that you have specified in your projects configuration.
+If the code is already checked out, we update the copy to the branch that you have specified in your project's configuration.
 
 Then we build the proper backend code for the type of documentation you've selected.
 

docs/builds.rst

@@ -4,7 +4,7 @@ Sharing
 .. note:: This feature only exists on our Business offering at `readthedocs.com <https://readthedocs.com/>`_.
 
 You can share your project with users outside of your company.
-There are two way to do this:
+There are two ways to do this:
 
 * by sending them a *secret link*,
 * by giving them a *password*.

docs/commercial/sharing.rst

@@ -28,6 +28,7 @@
     'djangodocs',
     'doc_extensions',
     'sphinx_tabs.tabs',
+    'sphinx-prompt',
 ]
 templates_path = ['_templates']
 
@@ -82,3 +83,7 @@
 
 # Activate autosectionlabel plugin
 autosectionlabel_prefix_document = True
+
+
+def setup(app):
+    app.add_stylesheet('css/sphinx_prompt_css.css')

docs/conf.py

@@ -49,20 +49,26 @@ install `pre-commit`_ and it will automatically run different linting tools
 and `yapf`_) to check your changes before you commit them. `pre-commit` will let
 you know if there were any problems that is wasn't able to fix automatically.
 
-To run the `pre-commit` command and check your changes::
+To run the `pre-commit` command and check your changes:
 
-    $ pip install -U pre-commit
-    $ git add <your-modified-files>
-    $ pre-commit run
+.. prompt:: bash $
 
-or to run against a specific file::
+    pip install -U pre-commit
+    git add <your-modified-files>
+    pre-commit run
 
-    $ pre-commit run --files <file.py>
+or to run against a specific file:
+
+.. prompt:: bash $
+
+    pre-commit run --files <file.py>
 
 `pre-commit` can also be run as a git pre-commit hook. You can set this up
-with::
+with:
+
+.. prompt:: bash $
 
-    $ pre-commit install
+    pre-commit install
 
 After this installation, the next time you run `git commit` the `pre-commit run`
 command will be run immediately and will inform you of the changes and errors.