Versioned Rolling branch (ros2#907)

* committing version test * remove tags Signed-off-by: maryaB-osr <[email protected]> * adding whitelists and trying released/in-development Signed-off-by: maryaB-osr <[email protected]> * comment out unused config with wrong type causing warning * Enable pulling from origin and released flag * Example warning banner * reverse order and move version list below navigation Signed-off-by: maryaB-osr <[email protected]> * reorder version list Signed-off-by: maryaB-osr <[email protected]> * refactored after separating versions Signed-off-by: maryaB-osr <[email protected]> * lowercase branch names, add dashing Signed-off-by: maryaB-osr <[email protected]> * fixing branch versioning Signed-off-by: maryaB-osr <[email protected]> * travis.yml: pip3 install sphinx_multiversion Signed-off-by: maryaB-osr <[email protected]> * remove missing-reference function Signed-off-by: maryaB-osr <[email protected]> * fix typo Signed-off-by: maryaB-osr <[email protected]> * no env config video for rolling Signed-off-by: maryaB-osr <[email protected]> Co-authored-by: Tully Foote <[email protected]>
CursedRock17 · Dec 3, 2020 · 5a8499a · 5a8499a
1 parent 36ace2a
commit 5a8499a
Show file tree

Hide file tree

Showing 98 changed files with 480 additions and 7,828 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,6 +5,7 @@ os: linux
 install:
   - pip3 install doc8 sphinx
   - pip3 install git+https://github.com/osrf/sphinx-tabs
+  - pip3 install sphinx_multiversion
 
 script:
   - make html 2> stderr.log

diff --git a/conf.py b/conf.py
@@ -16,10 +16,13 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
+import sys, os
 import itertools
 from docutils.parsers.rst import Directive
 
+sys.path.append(os.path.abspath('./sphinx-multiversion'))
+
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -66,7 +69,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-extensions = ['sphinx.ext.intersphinx', 'sphinx_tabs.tabs']
+extensions = ['sphinx.ext.intersphinx', 'sphinx_tabs.tabs', "sphinx_multiversion"]
 
 # Intersphinx mapping
 
@@ -85,7 +88,26 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+
+templates_path = [
+    "source/_templates",
+]
+
+html_sidebars = {
+    '**': ['navigation.html', 'versioning.html'],
+}
+
+# smv_tag_whitelist = None
+
+smv_branch_whitelist = r'^(rolling|foxy|eloquent|dashing)$'
+
+
+smv_released_pattern = r'^refs/(heads|remotes/[^/]+)/(foxy|eloquent|dashing).*$'
+smv_remote_whitelist = r'^(origin)$'
+smv_latest_version = 'foxy'
+
+
 
 html_favicon = 'favicon.ico'
 
@@ -206,6 +228,3 @@ def _missing_reference(app, env, node, contnode):
 
 def setup(app):
     RedirectFrom.register(app)
-    app.connect('missing-reference', make_router(
-        'Installation', 'Installation/Eloquent'
-    ))
diff --git a/setup.py b/setup.py
@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import os.path
+from setuptools import setup
+
+with open(os.path.join(os.path.dirname(__file__), "README.md")) as f:
+    readme = f.read()
+
+setup(
+    name="sphinx-multiversion",
+    description="Add support for multiple versions to sphinx",
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+    ],
+    author="Jan Holthuis",
+    author_email="[email protected]",
+    url="https://holzhaus.github.io/sphinx-multiversion/",
+    version="0.2.4",
+    install_requires=["sphinx >= 2.1"],
+    license="BSD",
+    packages=["sphinx_multiversion"],
+    entry_points={
+        "console_scripts": ["sphinx-multiversion=sphinx_multiversion:main",],
+    },
+)
diff --git a/source/Concepts.rst b/source/Concepts.rst
@@ -80,7 +80,7 @@ It can be summarized as follows:
 
 Nodes will only establish connections with other nodes if they have compatible `Quality of Service <../Tutorials/Quality-of-Service>` settings.
 
-Take the `talker-listener demo <latest-examples>` for example.
+Take the `talker-listener demo <talker-listener>` for example.
 Running the C++ talker node in one terminal will publish messages on a topic,
 and the Python listener node running in another terminal  will subscribe to messages on the same topic.
 

diff --git a/source/Contributing/Build-Cop-and-Build-Farmer-Guide.rst b/source/Contributing/Build-Cop-and-Build-Farmer-Guide.rst
@@ -133,7 +133,7 @@ In each case different actions should be taken by the build cop:
 
 * Important failures:
 
-  * Failure should be reported on the PR introducing it by tagging the submitter + the reviewer the +1’d it.
+  * Failure should be reported on the PR introducing it by tagging the submitter + the reviewer that +1’d it.
   * Submitter has to either:
 
     * Address it the same week
@@ -152,7 +152,7 @@ Tips
 
   * This is particularly useful for external repos such as Fast RTPS where old commits may get pushed to the master branch overnight, and are difficult to spot in the GitHub UI.
 
-* Times displayed at the top of jenkins jobs are in UTC. You can convert the times with e.g.:
+* Times displayed at the top of Jenkins jobs are in UTC. You can convert the times with e.g.:
 
   * https://www.google.com/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8#q=when+it's+9:25:12+PM+UTC+time+pst
 
@@ -210,7 +210,7 @@ Build Farmer Tasks
 
   * Rationale
 
-    * Anybody logging into the machine need to know that no one is working on it
+    * Anybody logging into the machine needs to know that no one is working on it
     * If the machine reboots the machine needs to be in an operational state without local changes
 
 * Making sure install instructions are up to date
@@ -250,7 +250,7 @@ If a node goes off-line:
 
 
 * For machines with VNC, you should try that first because many failures can be due to pop-up windows or required updates
-* If you don’t have any pop-ups and relaunching the jenkins client doesn’t fix it, then you'll have to start troubleshooting.
+* If you don’t have any pop-ups and relaunching the Jenkins client doesn’t fix it, then you'll have to start troubleshooting.
 * Looking at configuration difference between the nodes may be useful (java version, pip freeze, etc.)
 * For Linux nodes that have gone off-line (e.g. because of a reboot), they can be reconnected through the Jenkins web interface of that node
 

diff --git a/source/Installation.rst b/source/Installation.rst
@@ -7,11 +7,15 @@ Installation
    :hidden:
    :glob:
 
-   Installation/Crystal
-   Installation/Dashing
-   Installation/Eloquent
-   Installation/Foxy
-   Installation/Rolling
+   Installation/Summary
+   Installation/Linux-Development-Setup
+   Installation/Linux-Install-Binary
+   Installation/Linux-Install-Debians
+   Installation/macOS-Development-Setup
+   Installation/macOS-Install-Binary
+   Installation/Windows-Development-Setup
+   Installation/Windows-Install-Binary
+   Installation/Fedora-Development-Setup
    Installation/Latest-Development-Setup
    Installation/Maintaining-a-Source-Checkout
    Installation/Prerelease-Testing
@@ -26,13 +30,13 @@ We recommend using the most recent release available when possible.
 Select your ROS distribution
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-+---------------------------------------------------+--------------------------------------------------+------------------------------------------+
-| `ROS 2 Dashing Diademata <Installation/Dashing>`  | `ROS 2 Eloquent Elusor <Installation/Eloquent>`  | `ROS 2 Foxy Fitzroy <Installation/Foxy>` |
-+---------------------------------------------------+--------------------------------------------------+------------------------------------------+
-| Released May 2019                                 | Released November 2019                           | Released June 2020                       |
-+---------------------------------------------------+--------------------------------------------------+------------------------------------------+
-| Supported until May 2021                          | Supported until November 2020                    | Supported until May 2023                 |
-+---------------------------------------------------+--------------------------------------------------+------------------------------------------+
++---------------------------------------------------------------------+--------------------------------------------------------------------+------------------------------------------------------------+
+| `ROS 2 Dashing Diademata <../dashing/Installation/Summary.html>`__  | `ROS 2 Eloquent Elusor <../eloquent/Installation/Summary.html>`__  | `ROS 2 Foxy Fitzroy <../foxy/Installation/Summary.html>`__ |
++---------------------------------------------------------------------+--------------------------------------------------------------------+------------------------------------------------------------+
+| Released May 2019                                                   | Released November 2019                                             | Released June 2020                                         |
++---------------------------------------------------------------------+--------------------------------------------------------------------+------------------------------------------------------------+
+| Supported until May 2021                                            | Supported until November 2020                                      | Supported until May 2023                                   |
++---------------------------------------------------------------------+--------------------------------------------------------------------+------------------------------------------------------------+
 
 
 For more detailed descriptions of each release see `REP-2000 <https://www.ros.org/reps/rep-2000.html>`_
@@ -50,4 +54,3 @@ General users with no special considerations should use the most recent release
 Contributing to ROS 2 core?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you plan to contribute directly to ROS 2 core packages, you can install the `latest development from source <Installation/Latest-Development-Setup>` which shares installation instructions with the `Rolling distribution <rolling_distribution>`.
-
diff --git a/source/Installation/Crystal.rst b/source/Installation/Crystal.rst
diff --git a/source/Installation/Crystal/Fedora-Development-Setup.rst b/source/Installation/Crystal/Fedora-Development-Setup.rst