Update documentation (#277)

* Add github_url directives to sphinx doc

* Fix heading in README

* added sphinx config to build this package standalone.

* Update ci-ros-lint with ignore list

Author: urfeex

.github/workflows/ci-ros-lint.yml

@@ -9,13 +9,18 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-          linter: [copyright, lint_cmake]
+        env:
+          - linter: copyright
+            arguments: '--exclude doc/conf.py'
+          - linter: lint_cmake
+            arguments: ''
     steps:
-    - uses: actions/checkout@v4
-    - uses: ros-tooling/[email protected]
-    - uses: ros-tooling/[email protected]
-      with:
-        distribution: rolling
-        linter: ${{ matrix.linter }}
-        package-name:
-          ur_description
+      - uses: actions/checkout@v4
+      - uses: ros-tooling/[email protected]
+      - uses: ros-tooling/[email protected]
+        with:
+          distribution: rolling
+          linter: ${{ matrix.env.linter }}
+          arguments: ${{ matrix.env.arguments }}
+          package-name:
+            ur_description

.pre-commit-config.yaml

@@ -89,6 +89,7 @@ repos:
         stages: [pre-commit]
         entry: ament_copyright
         language: system
+        args: ['--exclude', 'doc/conf.py']
 
   # Docs - RestructuredText hooks
   - repo: https://github.com/PyCQA/doc8

README.md

@@ -2,7 +2,7 @@
 
 This repository contains description files and meshes for *Universal Robots* manipulators.
 
-### Build status
+## Build status
 
 ROS2 Distro | Branch | Build status | Released packages
 :---------: | :----: | :----------: | :---------------:

doc/conf.py

@@ -0,0 +1,82 @@
+project = "ur_description"
+copyright = "2025, Universal Robots A/S"
+author = "Felix Exner"
+
+# The short X.Y version
+version = ""
+# The full version, including alpha/beta/rc tags
+release = ""
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = [".rst"]
+
+# The master toctree document.
+master_doc = "index"
+
+numfig = True
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# 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
+
+# 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"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "ur_description_doc"

doc/index.rst

@@ -1,3 +1,7 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Description/blob/rolling/doc/index.rst
+
+.. _ur_description:
+
 ur_description
 ==============
 

doc/migration/jazzy.rst

@@ -1,3 +1,5 @@
+:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_Description/blob/rolling/doc/migration/jazzy.rst
+
 ur_description
 ^^^^^^^^^^^^^^