Merge branch 'master' into remove-usage-of-project-doctype

Author: stsewd

.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/mergeable.yml

@@ -0,0 +1,28 @@
+# ProBot Mergeable Bot
+# https://github.com/jusx/mergeable
+
+mergeable:
+  pull_requests:
+    approvals:
+      # Minimum of approvals needed.
+      min: 1
+        message: 'The PR must have a minimum of 1 approvals.'
+
+    description:
+      no_empty:
+        # Do not allow empty descriptions on PR.
+        enabled: false
+        message: 'Description can not be empty.'
+
+      must_exclude:
+        # Do not allow 'DO NOT MERGE' phrase on PR's description.
+        regex: 'DO NOT MERGE'
+        message: 'Description says that the PR should not be merged yet.'
+
+    # Do not allow 'WIP' on PR's title.
+    title: 'WIP'
+
+    label:
+      # Do not allow PR with label 'PR: work in progress'
+      must_exclude: 'PR: work in progress'
+      message: 'This PR is work in progress.'

.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

.travis.yml

@@ -1,12 +1,10 @@
 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:
   include:
+    - python: 3.6
+      env: TOXENV=py36 ES_VERSION=1.3.9 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
     - python: 3.6
       env: TOXENV=docs
     - python: 3.6
@@ -46,6 +44,6 @@ notifications:
 
 branches:
   only:
-  - master 
+  - master
   - rel # Community release branch
   - relcorp # Corporate release branch

CHANGELOG.rst

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2017 Read the Docs, Inc & contributors
+Copyright (c) 2010-2019 Read the Docs, Inc & contributors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

LICENSE

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

README.rst

@@ -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)

common

@@ -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/.rstcheck.cfg

@@ -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/_static/css/sphinx_prompt_css.css

@@ -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.
 
@@ -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/api/v2.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/builds.rst

@@ -6,7 +6,6 @@
 import sys
 
 import sphinx_rtd_theme
-from recommonmark.parser import CommonMarkParser
 
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.dirname(__file__))
@@ -28,13 +27,12 @@
     'djangodocs',
     'doc_extensions',
     'sphinx_tabs.tabs',
+    'sphinx-prompt',
+    'recommonmark',
 ]
 templates_path = ['_templates']
 
 source_suffix = ['.rst', '.md']
-source_parsers = {
-    '.md': CommonMarkParser,
-}
 
 master_doc = 'index'
 project = u'Read the Docs'
@@ -82,3 +80,7 @@
 
 # Activate autosectionlabel plugin
 autosectionlabel_prefix_document = True
+
+
+def setup(app):
+    app.add_stylesheet('css/sphinx_prompt_css.css')

docs/commercial/sharing.rst

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