Document names of frontend action arguments

launch_ros/doc/source/actions.rst

@@ -0,0 +1,50 @@
+`launch_ros` actions
+====================
+
+Action frontend arguments names
+-------------------------------
+
+Most of the `launch_ros` Python actions (:class:`launch_ros.actions`) are `available through the XML and YAML frontends <https://docs.ros.org/en/rolling/How-To-Guides/Launch-file-different-formats.html>`_.
+The name of the action arguments might vary between the underlying Python implementation and the frontends.
+
+:class:`launch_ros.actions.Node`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Action frontend name: ``node``.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Python argument name
+     - frontend argument name
+   * - ``arguments``
+     - ``args``
+   * - ``executable``
+     - ``exec``
+   * - ``exec_name``
+     - ``exec_name``
+   * - ``namespace``
+     - ``namespace``
+   * - ``node_name``
+     - ``node-name``
+   * - ``package``
+     - ``pkg``
+   * - ``parameters``
+     - ``param`` (``name``, ``value``)
+   * - ``remappings``
+     - ``remap`` (``from``, ``to``)
+   * - ``ros_arguments``
+     - ``ros_args``
+
+:class:`launch_ros.actions.PushROSNamespace`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Action frontend name: ``push_ros_namespace``.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Python argument name
+     - frontend argument name
+   * - ``namespace``
+     - ``namespace``

launch_ros/doc/source/conf.py

@@ -0,0 +1,207 @@
+# Copyright 2018 Open Source Robotics Foundation, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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
+# The python interpreter that executes this conf.py file will not have this
+# package's modules in the system path which will lead to import failures when
+# running sphinx-autodoc. As a workaround, the sphinx_builder.py script in
+# rosdoc2 will copy this package's modules along with this conf.py into a folder
+# with the same name of this package within the docs_build directory.
+# Hence we add the parent folder to the system path so that the modules from
+# this package can be imported.
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+# type: ignore
+
+project = 'launch_ros'
+copyright = '2024, Open Source Robotics Foundation, Inc.'  # noqa
+author = 'Open Source Robotics Foundation, Inc.'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.27.2'
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+]
+
+# autodoc settings
+autodoc_default_options = {
+    'special-members': '__init__',
+    'class-doc-from': 'class',
+}
+autodoc_class_signature = 'separated'
+
+# 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', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = 'launchdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+# latex_elements: dict[str, str] = {
+#     # The paper size ('letterpaper' or 'a4paper').
+
+#     'papersize': 'letterpaper',
+
+#     # The font size ('10pt', '11pt' or '12pt').
+
+#     'pointsize': '10pt',
+
+#     # Additional stuff for the LaTeX preamble.
+
+#     'preamble': '',
+
+#     # Latex figure (float) alignment
+
+#     'figure_align': 'htbp',
+# }
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'launch_ros.tex', 'launch_ros Documentation',
+     'Open Source Robotics Foundation, Inc.', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'launch_ros', 'launch_ros Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'launch_ros', 'launch_ros Documentation',
+     author, 'launch_ros', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

launch_ros/doc/source/index.rst

@@ -0,0 +1,16 @@
+Welcome to launch_ros's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   actions
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`