Skip to content

Commit

Permalink
Address the latest comments in the code review
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri committed Mar 10, 2022
1 parent af7ce40 commit 483182c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions docs/user/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,14 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
``READTHEDOCS``, Whether the build is running inside RTD, ``True``
``READTHEDOCS_VERSION``, The RTD slug of the version which is being built, ``latest``
``READTHEDOCS_VERSION_NAME``, Corresponding version name as displayed in RTD's version switch menu, ``stable``
``READTHEDOCS_VERSION_TYPE``, Type of the event triggering the build, ``branch`` ``tag`` ``external`` ``unknown``
``READTHEDOCS_VERSION_TYPE``, Type of the event triggering the build, ``branch`` | ``tag`` | ``external`` (for :doc:`pull request builds </pull-requests>`) | ``unknown``
``READTHEDOCS_PROJECT``, The RTD slug of the project which is being built, ``my-example-project``
``READTHEDOCS_LANGUAGE``, The RTD language slug of the project which is being built, ``en``


.. note::

- The term slug is used to refer to a unique string across projects/versions containing ASCII characters only.
This value is used in the URLs of your documentation.

- If ``READTHEDOCS_VERSION_TYPE`` is ``external``,
it means that the version was built from pull request. See :doc:`/pull-requests`.
The term slug is used to refer to a unique string across projects/versions containing ASCII characters only.
This value is used in the URLs of your documentation.


.. tip::
Expand Down
2 changes: 1 addition & 1 deletion docs/user/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ GitHub
*application/x-www-form-urlencoded* work
* Leave the **Secrets** field blank
* Select **Let me select individual events**,
and mark **Branch or tag creation**, **Branch or tag deletion**, **Pull requests** and **Pushes** events.
and mark **Branch or tag creation**, **Branch or tag deletion**, **Pull requests** and **Pushes** events
* Ensure **Active** is enabled; it is by default
* Finish by clicking **Add webhook**. You may be prompted to enter your GitHub password to confirm your action.

Expand Down

0 comments on commit 483182c

Please sign in to comment.