Adding migration notes to package docs (UniversalRobots#325)

* Add migration notes to package docs
* Add doc building CI job

Author: URJala

.github/workflows/sphinx_build.yml

@@ -0,0 +1,30 @@
+---
+name: "Build documentation"
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - rolling
+  schedule:
+    - cron: '38 2 * * *'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          cache: 'pip'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r doc_requirements.txt
+      - name: Build documentation
+        run: |
+          sphinx-build -W -b html doc _doc_build

doc/conf.py

@@ -36,12 +36,12 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "migration/*.rst"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -63,7 +63,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

doc/index.rst

@@ -9,10 +9,11 @@ This package contains the kinematic and visual description of Universal Robots m
 2.
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
    :caption: Contents:
 
    robot_frames
+   migration_notes
 
 .. contents::
    :depth: 2

doc/migration_notes.rst

@@ -0,0 +1,12 @@
+Migration notes
+===============
+
+Iron -> Jazzy
+^^^^^^^^^^^^^
+.. include:: migration/jazzy.rst
+    :start-line: 4
+
+Jazzy -> Kilted
+^^^^^^^^^^^^^^^
+.. include:: migration/kilted.rst
+    :start-line: 4

doc_requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+sphinx-copybutton
+sphinx-tabs
+sphinx_rtd_theme
+catkin-pkg