Skip to content

Commit

Permalink
Add READTHEDOCS_VERSION_{TYPE,NAME} env vars
Browse files Browse the repository at this point in the history
These variables make it easy for configuration scripts to differentiate
between regular builds and builds triggered by PRs.

Moreover, they are quite handy to setting up `html_title` in a way that
matches the version being displayed in the RTD's version switch menu.
  • Loading branch information
abravalheri committed Jun 8, 2021
1 parent 3a247f0 commit afc75f7
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
14 changes: 13 additions & 1 deletion docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,23 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
:widths: 15, 10, 30

``READTHEDOCS``, Whether the build is running inside RTD, ``True``
``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest``
``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_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 here to indicate a string without some types characters
considered special in certain circunstances. The version slug can contain some
characters not usually present in other slugs.

- The ``external`` value for ``READTHEDOCS_VERSION_TYPE`` will usually be
associated with builds triggered by pull requests. See :doc:`/pull-requests`.


.. tip::

In case extra environment variables are needed to the build process (like secrets, tokens, etc),
Expand Down
2 changes: 2 additions & 0 deletions readthedocs/projects/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,8 @@ def get_rtd_env_vars(self):
env = {
'READTHEDOCS': 'True',
'READTHEDOCS_VERSION': self.version.slug,
'READTHEDOCS_VERSION_TYPE': self.version.type,
'READTHEDOCS_VERSION_NAME': self.version.explicit_name,
'READTHEDOCS_PROJECT': self.project.slug,
'READTHEDOCS_LANGUAGE': self.project.language,
}
Expand Down
4 changes: 3 additions & 1 deletion readthedocs/rtd_tests/tests/test_builds.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ def test_get_env_vars(self):
project=project,
)
build = get(Build)
version = get(Version, slug='1.8', project=project)
version = get(Version, slug='1.8', project=project, type=BRANCH)
task = UpdateDocsTaskStep(
project=project, version=version, build={'id': build.pk},
)
Expand All @@ -353,6 +353,8 @@ def test_get_env_vars(self):
'NO_COLOR': '1',
'READTHEDOCS': 'True',
'READTHEDOCS_VERSION': version.slug,
'READTHEDOCS_VERSION_TYPE': BRANCH,
'READTHEDOCS_VERSION_NAME': version.verbose_name,
'READTHEDOCS_PROJECT': project.slug,
'READTHEDOCS_LANGUAGE': project.language,
'BIN_PATH': os.path.join(
Expand Down

0 comments on commit afc75f7

Please sign in to comment.