Merge branch 'master' into docs-for-feature-flags

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

docs/.rstcheck.cfg

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

docs/_static/css/sphinx_prompt_css.css

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

@@ -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/builds.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/commercial/sharing.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/conf.py

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

docs/custom_installs/elasticsearch.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!