Code autogenerated from Kurento/doc-kurento@522cd01

.readthedocs.yml

@@ -1,4 +1,4 @@
-# ReadTheDocs configuration file.
+# Read the Docs configuration file.
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html
 
 version: 2

source/_templates/breadcrumbs.html

@@ -0,0 +1,8 @@
+{% extends "!breadcrumbs.html" %}
+
+<!--
+  Override the Read the Docs source repo, which would normally be
+  "doc-kurento-readthedocs".
+  This changes the URL that is linked as "Edit on GitHub" on the top right.
+-->
+{% set github_repo = 'doc-kurento' %}

source/conf.py

@@ -110,9 +110,6 @@
     'display_version': True
 }
 
-# Force the "Edit on GitHub" button to use this URL.
-github_url = 'https://github.com/Kurento/doc-kurento'
-
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 html_logo = 'images/kurento-white.png'

source/dev/release.rst

@@ -1187,7 +1187,7 @@ For this reason, the documentation must be built only after all the other module
 
 #. Ensure that the whole nightly CI chain works:
 
-   Job *doc-kurento* -> job *doc-kurento-readthedocs* -> `New build at ReadTheDocs`_.
+   Job *doc-kurento* -> job *doc-kurento-readthedocs* -> `New build at Read the Docs`_.
 
 #. Edit `VERSIONS.conf.sh`_ to set all relevant version numbers: version of the documentation itself, and all referred modules and client libraries.
 
@@ -1202,15 +1202,15 @@ For this reason, the documentation must be built only after all the other module
    - ``[VERSION_TUTORIAL_JS]``: Repo `kurento-tutorial-js`_.
    - ``[VERSION_TUTORIAL_NODE]``: Repo `kurento-tutorial-node`_.
 
-#. In *VERSIONS.conf.sh*, set *VERSION_RELEASE* to *true*. Remember to set it again to *false* after the release, when starting a new development iteration.
+#. In *VERSIONS.conf.sh*, set *VERSION_RELEASE* to **true**. Remember to set it again to *false* after the release, when starting a new development iteration.
 
 #. Test the build locally, check everything works.
 
    .. code-block:: shell
 
       make html
 
-   Note that the JavaDoc and JsDoc pages won't be generated locally if you don't have your system prepared to do so; also there are some Sphinx constructs or plugins that might fail if you don't have them ready to use, but the ReadTheDocs servers have them so they should end up working fine.
+   Note that the JavaDoc and JsDoc pages won't be generated locally if you don't have your system prepared to do so; also there are some Sphinx constructs or plugins that might fail if you don't have them ready to use, but the Read the Docs servers have them so they should end up working fine.
 
 #. Git add, commit, and push. This will trigger a nightly build, where you can **check the result** of the documentation builds to have an idea of how the final release build will end up looking like, at https://doc-kurento.readthedocs.io/en/latest/.
 
@@ -1226,23 +1226,15 @@ For this reason, the documentation must be built only after all the other module
 
 #. Run the `doc-kurento CI job`_ with the parameter *JOB_RELEASE* **ENABLED**.
 
-#. CI automatically tags Release versions in both ReadTheDocs source repos `doc-kurento`_ and `doc-kurento-readthedocs`_, so the release will show up in the ReadTheDocs dashboard.
+#. CI automatically tags Release versions in both Read the Docs source repos `doc-kurento`_ and `doc-kurento-readthedocs`_, so the release will show up in the Read the Docs dashboard.
 
    .. note::
 
-      If you made a mistake and want to re-create the git tag with a different commit, remember that the re-tagging must be done manually in both *doc-kurento* and *doc-kurento-readthedocs* repos. ReadTheDocs CI servers will read the latter one to obtain the documentation sources and release tags.
+      If you made a mistake and want to re-create the git tag with a different commit, remember that the re-tagging must be done manually in both *doc-kurento* and *doc-kurento-readthedocs* repos. Read the Docs CI servers will read the latter one to obtain the documentation sources and release tags.
 
-#. Open `ReadTheDocs Builds`_. If the new version hasn't been detected and built, do it manually: use the *Build Version* button to force a build of the *latest* version.
+#. Open `Read the Docs Builds`_. If the new version hasn't been detected and built, do it manually: use the *Build Version* button to force a build of the *latest* version. Doing this, Read the Docs will "realize" that there is a new tagged release version of the documentation in the *doc-kurento-readthedocs* repo.
 
-   Doing this, ReadTheDocs will "realize" that there is a new tagged release version of the documentation, in the *doc-kurento-readthedocs* repo. After the build is finished, the new release version will be available for selection in the next step.
-
-#. Open `ReadTheDocs Advanced Settings`_ and select the new version in the *Default Version* combo box.
-
-   .. note::
-
-      We don't set the *Default Version* field to "*stable*", because we want that the actual version number gets shown in the upper part of the side panel (below the Kurento logo, above the search box) when users open the documentation. If "*stable*" was selected here, then users would just see the word "*stable*" in the mentioned panel.
-
-#. **AFTER THE WHOLE RELEASE HAS BEEN COMPLETED**: Set *VERSION_RELEASE* to *false*. Now, create a Release Notes document template where to write changes that will accumulate for the next release.
+#. **AFTER THE WHOLE RELEASE HAS BEEN COMPLETED**: Set *VERSION_RELEASE* to **false**. Now, create a Release Notes document template where to write changes that will accumulate for the next release.
 
    **All-In-One** script:
 
@@ -1363,6 +1355,6 @@ For this reason, the documentation must be built only after all the other module
 .. _Nexus Sonatype Staging Repositories: https://oss.sonatype.org/#stagingRepositories
 .. _Semantic Versioning: https://semver.org/spec/v2.0.0.html#summary
 .. _this Ask Ubuntu answer: https://askubuntu.com/questions/620533/what-is-the-meaning-of-the-xubuntuy-string-in-ubuntu-package-names/620539#620539
-.. _ReadTheDocs Builds: https://readthedocs.org/projects/doc-kurento/builds/
-.. _New build at ReadTheDocs: https://readthedocs.org/projects/doc-kurento/builds/
-.. _ReadTheDocs Advanced Settings: https://readthedocs.org/dashboard/doc-kurento/advanced/
+.. _Read the Docs Builds: https://readthedocs.org/projects/doc-kurento/builds/
+.. _New build at Read the Docs: https://readthedocs.org/projects/doc-kurento/builds/
+.. _Read the Docs Advanced Settings: https://readthedocs.org/dashboard/doc-kurento/advanced/