Merge branch 'master' into HEAD

Author: dojutsu-user

.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

.gitignore

@@ -7,6 +7,7 @@
 .DS_Store
 .cache
 .coverage
+.coverage.*
 .idea
 .vagrant
 .vscode
@@ -22,7 +23,7 @@ celerybeat-schedule.*
 deploy/.vagrant
 dist/*
 local_settings.py
-locks/*
+locks/**
 logs/*
 media/dash
 media/epub

.readthedocs.yml

@@ -3,4 +3,4 @@ formats: all
 sphinx:
   configuration: docs/conf.py
 python:
-  requirements: requirements.txt
+  requirements: requirements/local-docs-build.txt

CHANGELOG.rst

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

README.rst

@@ -78,6 +78,6 @@ when you push to GitHub.
 License
 -------
 
-`MIT`_ © 2010-2017 Read the Docs, Inc & contributors
+`MIT`_ © 2010-2019 Read the Docs, Inc & contributors
 
 .. _MIT: LICENSE

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

@@ -225,3 +225,8 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
 +-------------------------+--------------------------------------------------+----------------------+
 | ``READTHEDOCS_PROJECT`` | The RTD name of the project which is being built | ``myexampleproject`` |
 +-------------------------+--------------------------------------------------+----------------------+
+
+.. tip::
+
+   In case extra environment variables are needed to the build process (like secrets, tokens, etc),
+   you can add them going to **Admin > Environment Variables** in your project. See :doc:`guides/environment-variables`.

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.

docs/contribute.rst

@@ -12,9 +12,11 @@ Installing Java
 Elasticsearch requires Java 8 or later. Use `Oracle official documentation <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_. 
 or opensource distribution like `OpenJDK <http://openjdk.java.net/install/>`_.
 
-After installing java, verify the installation by,::
+After installing java, verify the installation by,:
 
-    $ java -version
+.. prompt:: bash $
+
+    java -version
 
 The result should be something like this::
 
@@ -31,52 +33,68 @@ Elasticsearch can be downloaded directly from elastic.co. For Ubuntu, it's best
 RTD currently uses elasticsearch 1.x which can be easily downloaded and installed from `elastic.co 
 <https://www.elastic.co/downloads/past-releases/elasticsearch-1-3-8/>`_.
 
-Install the downloaded package by following command::
+Install the downloaded package by following command:
+
+.. prompt:: bash $
 
-    $ sudo apt install .{path-to-downloaded-file}/elasticsearch-1.3.8.deb
+    sudo apt install .{path-to-downloaded-file}/elasticsearch-1.3.8.deb
 
 Custom setup
 ------------
 
-You need the icu plugin::
+You need the icu plugin:
+
+.. prompt:: bash $
 
-    $ elasticsearch/bin/plugin -install elasticsearch/elasticsearch-analysis-icu/2.3.0
+    elasticsearch/bin/plugin -install elasticsearch/elasticsearch-analysis-icu/2.3.0
 
 Running Elasticsearch from command line
 ---------------------------------------
 
-Elasticsearch is not started automatically after installation. How to start and stop Elasticsearch depends on whether your system uses SysV init or systemd (used by newer distributions). You can tell which is being used by running this command::
+Elasticsearch is not started automatically after installation. How to start and stop Elasticsearch depends on whether your system uses SysV init or systemd (used by newer distributions). You can tell which is being used by running this command:
 
-    $ ps -p 1   
+.. prompt:: bash $
+
+    ps -p 1   
 
 **Running Elasticsearch with SysV init**
 
-Use the ``update-rc.d command`` to configure Elasticsearch to start automatically when the system boots up::
+Use the ``update-rc.d command`` to configure Elasticsearch to start automatically when the system boots up:
+
+.. prompt:: bash $
+
+    sudo update-rc.d elasticsearch defaults 95 10
 
-    $ sudo update-rc.d elasticsearch defaults 95 10
+Elasticsearch can be started and stopped using the service command:
 
-Elasticsearch can be started and stopped using the service command::
+.. prompt:: bash $
 
-    $ sudo -i service elasticsearch start
-    $ sudo -i service elasticsearch stop
+    sudo -i service elasticsearch start
+    sudo -i service elasticsearch stop
 
 If Elasticsearch fails to start for any reason, it will print the reason for failure to STDOUT. Log files can be found in /var/log/elasticsearch/.
 
 **Running Elasticsearch with systemd**
 
-To configure Elasticsearch to start automatically when the system boots up, run the following commands::
+To configure Elasticsearch to start automatically when the system boots up, run the following commands:
 
-    $ sudo /bin/systemctl daemon-reload
-    $ sudo /bin/systemctl enable elasticsearch.service
+.. prompt:: bash $
 
-Elasticsearch can be started and stopped as follows::
+    sudo /bin/systemctl daemon-reload
+    sudo /bin/systemctl enable elasticsearch.service
 
-    $ sudo systemctl start elasticsearch.service
-    $ sudo systemctl stop elasticsearch.service
+Elasticsearch can be started and stopped as follows:
 
-To verify run::
+.. prompt:: bash $
 
-    $ curl http://localhost:9200
+    sudo systemctl start elasticsearch.service
+    sudo systemctl stop elasticsearch.service
+
+To verify run:
+
+.. prompt:: bash $
+
+    curl http://localhost:9200
 
 
 You should get something like::
@@ -97,12 +115,16 @@ You should get something like::
 Index the data available at RTD database
 ----------------------------------------
 
-You need to create the indexes::
+You need to create the indexes:
+
+.. prompt:: bash $
+
+    python manage.py provision_elasticsearch
 
-    $ python manage.py provision_elasticsearch
+In order to search through the RTD database, you need to index it into the elasticsearch index:
 
-In order to search through the RTD database, you need to index it into the elasticsearch index:: 
+.. prompt:: bash $ 
 
-    $ python manage.py reindex_elasticsearch
+    python manage.py reindex_elasticsearch
 
 You are ready to go!