From 19a4eaa8f13f75f5a820ff4befb7d60d995448c6 Mon Sep 17 00:00:00 2001 From: R Kent James Date: Fri, 21 Nov 2025 12:30:20 -0800 Subject: [PATCH 1/3] Modernize conf.py files to only include modified Copyright, eliminating cruft. Signed-off-by: R Kent James Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later --- examples_tf2_py/doc/conf.py | 27 ++++ test_tf2/doc/conf.py | 27 ++++ tf2/doc/conf.py | 174 +----------------------- tf2_bullet/doc/conf.py | 27 ++++ tf2_eigen/doc/conf.py | 27 ++++ tf2_eigen_kdl/doc/conf.py | 27 ++++ tf2_geometry_msgs/doc/conf.py | 27 ++++ tf2_kdl/docs/source/conf.py | 246 +++------------------------------ tf2_msgs/doc/conf.py | 27 ++++ tf2_py/doc/conf.py | 27 ++++ tf2_ros/doc/conf.py | 249 +++------------------------------- tf2_ros_py/doc/source/conf.py | 167 +---------------------- tf2_sensor_msgs/doc/conf.py | 27 ++++ tf2_tools/doc/conf.py | 27 ++++ 14 files changed, 314 insertions(+), 792 deletions(-) create mode 100644 examples_tf2_py/doc/conf.py create mode 100644 test_tf2/doc/conf.py create mode 100644 tf2_bullet/doc/conf.py create mode 100644 tf2_eigen/doc/conf.py create mode 100644 tf2_eigen_kdl/doc/conf.py create mode 100644 tf2_geometry_msgs/doc/conf.py create mode 100644 tf2_msgs/doc/conf.py create mode 100644 tf2_py/doc/conf.py create mode 100644 tf2_sensor_msgs/doc/conf.py create mode 100644 tf2_tools/doc/conf.py diff --git a/examples_tf2_py/doc/conf.py b/examples_tf2_py/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/examples_tf2_py/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/test_tf2/doc/conf.py b/test_tf2/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/test_tf2/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2/doc/conf.py b/tf2/doc/conf.py index 6b01bfb5f..b12032751 100644 --- a/tf2/doc/conf.py +++ b/tf2/doc/conf.py @@ -16,184 +16,12 @@ # # 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/master/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 -sys.path.insert(0, os.path.abspath('.')) - # -- Project information ----------------------------------------------------- - from datetime import datetime now = datetime.now() # current date and time year = now.strftime("%Y") -project = 'tf2' -copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc.' # noqa +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' - -# The short X.Y version -version = '0.44' -# The full version, including alpha/beta/rc tags -release = '0.44.0' - - -# -- 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.autosummary', - 'sphinx.ext.doctest', - 'sphinx.ext.coverage', - 'sphinx_rtd_theme', - 'myst_parser' -] - -# 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 = 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 = 'sphinx_rtd_theme' - -# 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 = [] - -# 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 = 'tf2_doc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # 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', -} - - -# -- 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, 'tf2', 'tf2 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, 'tf2', 'tf2 Documentation', - author, 'tf2', 'ROS 2 implementation for the transform interface', - 'Miscellaneous'), -] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - - -# -- Extension configuration ------------------------------------------------- - -autoclass_content = 'both' - -autodoc_default_options = { - 'members': True, # document members - 'undoc-members': True, # also document members without documentation -} diff --git a/tf2_bullet/doc/conf.py b/tf2_bullet/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_bullet/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_eigen/doc/conf.py b/tf2_eigen/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_eigen/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_eigen_kdl/doc/conf.py b/tf2_eigen_kdl/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_eigen_kdl/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_geometry_msgs/doc/conf.py b/tf2_geometry_msgs/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_geometry_msgs/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_kdl/docs/source/conf.py b/tf2_kdl/docs/source/conf.py index f381da46e..b12032751 100644 --- a/tf2_kdl/docs/source/conf.py +++ b/tf2_kdl/docs/source/conf.py @@ -1,237 +1,27 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Open Source Robotics Foundation, Inc. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. +# Copyright 2024 Open Source Robotics Foundation, Inc. # -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. +# 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 # -# * Neither the name of the Open Source Robotics Foundation, Inc. nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. +# http://www.apache.org/licenses/LICENSE-2.0 # -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. +# 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. - -# -# tf2 documentation build configuration file, created by -# sphinx-quickstart on Mon Jun 1 14:21:53 2009. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. +# -*- coding: utf-8 -*- # -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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. -# sys.path.append(os.path.abspath('./src/tf2_kdl')) - -# -- General configuration ---------------------------------------------------- - -# 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.imgmath'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'tf2_kdl' -copyright = u'2016, Open Source Robotics Foundation' # noqa(A001) - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. +# Configuration file for the Sphinx documentation builder. # -# The short X.Y version. -version = '0.5' -# The full version, including alpha/beta/rc tags. -release = '0.5.13' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_build'] - -exclude_patterns = ['_CHANGELOG.rst'] - -# The reST default role (used for this markup: `text`) to use -# for all documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - - -# -- Options for HTML output ------------------------------------------------ - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' - -# 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 themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_use_modindex = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'tfdoc' - - -# -- Options for LaTeX output ------------------------------------------------- - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, -# documentclass [howto/manual]). -latex_documents = [ - ('index', 'tf.tex', u'stereo\\_utils Documentation', - u'Tully Foote and Eitan Marder-Eppstein', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] -# If false, no module index is generated. -# latex_use_modindex = True +# -- Project information ----------------------------------------------------- +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 'python': ('http://docs.python.org/3', None), - 'opencv': ('http://docs.opencv.org/3.0-last-rst', None), - 'numpy': ('http://docs.scipy.org/doc/numpy', None) - } +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_msgs/doc/conf.py b/tf2_msgs/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_msgs/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_py/doc/conf.py b/tf2_py/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_py/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_ros/doc/conf.py b/tf2_ros/doc/conf.py index eff933c2d..b12032751 100644 --- a/tf2_ros/doc/conf.py +++ b/tf2_ros/doc/conf.py @@ -1,238 +1,27 @@ -# -*- coding: utf-8 -*- -# -# tf documentation build configuration file, created by -# sphinx-quickstart on Mon Jun 1 14:21:53 2009. +# Copyright 2024 Open Source Robotics Foundation, Inc. # -# This file is execfile()d with the current directory set to its containing dir. +# 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 # -# Note that not all possible configuration values are present in this -# autogenerated file. +# http://www.apache.org/licenses/LICENSE-2.0 # -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# 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. -#sys.path.append(os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# 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', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' +# 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. -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# 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 = [] - -# General information about the project. -project = u'tf2_ros' -copyright = u'2009, Willow Garage, Inc.' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. # -# The short X.Y version. -version = '0.36' -# The full version, including alpha/beta/rc tags. -release = '0.36.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'sphinx_rtd_theme' - -# 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 themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_use_modindex = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'tfdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'tf.tex', u'stereo\\_utils Documentation', - u'Tully Foote and Eitan Marder-Eppstein', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True - -# -- 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, 'tf2_ros', 'tf2_ros Documentation', - [copyright], 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, 'tf2_ros', 'tf2_ros Documentation', - copyright, 'tf2_ros', 'ROS 2 ', - 'Miscellaneous'), -] +# -- Project information ----------------------------------------------------- -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 'python': ('http://docs.python.org/3', None), - 'opencv': ('http://docs.opencv.org/3.0-last-rst', None), - 'numpy': ('http://docs.scipy.org/doc/numpy', None) - } +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") -autoclass_content = "both" +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_ros_py/doc/source/conf.py b/tf2_ros_py/doc/source/conf.py index 791afe1db..b12032751 100644 --- a/tf2_ros_py/doc/source/conf.py +++ b/tf2_ros_py/doc/source/conf.py @@ -1,5 +1,4 @@ - -# Copyright 2023 Open Source Robotics Foundation, Inc. +# Copyright 2024 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. @@ -17,166 +16,12 @@ # # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- 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 -sys.path.insert(0, os.path.abspath('.')) - # -- Project information ----------------------------------------------------- -project = 'tf2_ros_py' -copyright = '2023, Open Source Robotics Foundation, Inc.' # noqa: A001 -author = 'Open Source Robotics Foundation, Inc.' - -# The full version, including alpha/beta/rc tags -release = '0.30.0' - - -# -- General configuration --------------------------------------------------- - -# 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' - -# 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 = {} +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") -# 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 = 'tf2_ros_pydoc' - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # 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, 'tf2_ros_py.tex', 'tf2_ros_py 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, 'tf2_ros_py', 'tf2_ros_py 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, 'tf2_ros_py', 'tf2_ros_py Documentation', - author, 'tf2_ros_py', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Extension configuration ------------------------------------------------- - -# -- Options for intersphinx extension --------------------------------------- - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} - -# -- Options for todo extension ---------------------------------------------- - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_sensor_msgs/doc/conf.py b/tf2_sensor_msgs/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_sensor_msgs/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_tools/doc/conf.py b/tf2_tools/doc/conf.py new file mode 100644 index 000000000..b12032751 --- /dev/null +++ b/tf2_tools/doc/conf.py @@ -0,0 +1,27 @@ +# Copyright 2024 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. +# + +# -- Project information ----------------------------------------------------- + +from datetime import datetime +now = datetime.now() # current date and time +year = now.strftime("%Y") + +copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa +author = 'Open Source Robotics Foundation, Inc.' From 3d68c1dc194fe3127a5a8317987baaccc244b359 Mon Sep 17 00:00:00 2001 From: R Kent James Date: Mon, 1 Dec 2025 16:11:02 -0800 Subject: [PATCH 2/3] Update copyright date to 2025 in conf.py Signed-off-by: R Kent James Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later --- examples_tf2_py/doc/conf.py | 2 +- test_tf2/doc/conf.py | 2 +- tf2/doc/conf.py | 2 +- tf2_bullet/doc/conf.py | 2 +- tf2_eigen/doc/conf.py | 2 +- tf2_eigen_kdl/doc/conf.py | 2 +- tf2_geometry_msgs/doc/conf.py | 2 +- tf2_kdl/docs/source/conf.py | 2 +- tf2_msgs/doc/conf.py | 2 +- tf2_py/doc/conf.py | 2 +- tf2_ros/doc/conf.py | 2 +- tf2_ros_py/doc/source/conf.py | 2 +- tf2_sensor_msgs/doc/conf.py | 2 +- tf2_tools/doc/conf.py | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/examples_tf2_py/doc/conf.py b/examples_tf2_py/doc/conf.py index b12032751..440b7a504 100644 --- a/examples_tf2_py/doc/conf.py +++ b/examples_tf2_py/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/test_tf2/doc/conf.py b/test_tf2/doc/conf.py index b12032751..440b7a504 100644 --- a/test_tf2/doc/conf.py +++ b/test_tf2/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2/doc/conf.py b/tf2/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2/doc/conf.py +++ b/tf2/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_bullet/doc/conf.py b/tf2_bullet/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_bullet/doc/conf.py +++ b/tf2_bullet/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_eigen/doc/conf.py b/tf2_eigen/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_eigen/doc/conf.py +++ b/tf2_eigen/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_eigen_kdl/doc/conf.py b/tf2_eigen_kdl/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_eigen_kdl/doc/conf.py +++ b/tf2_eigen_kdl/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_geometry_msgs/doc/conf.py b/tf2_geometry_msgs/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_geometry_msgs/doc/conf.py +++ b/tf2_geometry_msgs/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_kdl/docs/source/conf.py b/tf2_kdl/docs/source/conf.py index b12032751..440b7a504 100644 --- a/tf2_kdl/docs/source/conf.py +++ b/tf2_kdl/docs/source/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_msgs/doc/conf.py b/tf2_msgs/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_msgs/doc/conf.py +++ b/tf2_msgs/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_py/doc/conf.py b/tf2_py/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_py/doc/conf.py +++ b/tf2_py/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_ros/doc/conf.py b/tf2_ros/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_ros/doc/conf.py +++ b/tf2_ros/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_ros_py/doc/source/conf.py b/tf2_ros_py/doc/source/conf.py index b12032751..440b7a504 100644 --- a/tf2_ros_py/doc/source/conf.py +++ b/tf2_ros_py/doc/source/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_sensor_msgs/doc/conf.py b/tf2_sensor_msgs/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_sensor_msgs/doc/conf.py +++ b/tf2_sensor_msgs/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. diff --git a/tf2_tools/doc/conf.py b/tf2_tools/doc/conf.py index b12032751..440b7a504 100644 --- a/tf2_tools/doc/conf.py +++ b/tf2_tools/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2024 Open Source Robotics Foundation, Inc. +# Copyright 2025 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. From 36997b17460e60d979287939cea73fa503c4ee84 Mon Sep 17 00:00:00 2001 From: R Kent James Date: Tue, 2 Dec 2025 09:12:36 -0800 Subject: [PATCH 3/3] Fix flake errors in conf.py; delete inadvertently added file from previous commit Signed-off-by: R Kent James Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later --- examples_tf2_py/doc/conf.py | 4 +-- test_tf2/doc/conf.py | 4 +-- tf2/doc/conf.py | 4 +-- tf2/rosdoc2.yaml.ild | 68 ----------------------------------- tf2_bullet/doc/conf.py | 4 +-- tf2_eigen/doc/conf.py | 4 +-- tf2_eigen_kdl/doc/conf.py | 4 +-- tf2_geometry_msgs/doc/conf.py | 4 +-- tf2_kdl/docs/source/conf.py | 4 +-- tf2_msgs/doc/conf.py | 4 +-- tf2_py/doc/conf.py | 4 +-- tf2_ros/doc/conf.py | 4 +-- tf2_ros_py/doc/source/conf.py | 4 +-- tf2_sensor_msgs/doc/conf.py | 4 +-- tf2_tools/doc/conf.py | 4 +-- 15 files changed, 28 insertions(+), 96 deletions(-) delete mode 100644 tf2/rosdoc2.yaml.ild diff --git a/examples_tf2_py/doc/conf.py b/examples_tf2_py/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/examples_tf2_py/doc/conf.py +++ b/examples_tf2_py/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/test_tf2/doc/conf.py b/test_tf2/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/test_tf2/doc/conf.py +++ b/test_tf2/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2/doc/conf.py b/tf2/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2/doc/conf.py +++ b/tf2/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2/rosdoc2.yaml.ild b/tf2/rosdoc2.yaml.ild deleted file mode 100644 index a80c829b8..000000000 --- a/tf2/rosdoc2.yaml.ild +++ /dev/null @@ -1,68 +0,0 @@ -## Default configuration, generated by rosdoc2. - -## This 'attic section' self-documents this file's type and version. -type: 'rosdoc2 config' -version: 1 - ---- - -settings: - ## If this is true, a standard index page is generated in the output directory. - ## It uses the package information from the 'package.xml' to show details - ## about the package, creates a table of contents for the various builders - ## that were run, and may contain links to things like build farm jobs for - ## this package or links to other versions of this package. - - ## If false, you can still include content that would have been in the index - ## into one of your '.rst' files from your Sphinx project, using the - ## '.. include::' directive in Sphinx. - ## For example, you could include it in a custom 'index.rst' so you can have - ## the standard information followed by custom content. - - ## TODO(wjwwood): provide a concrete example of this (relative path?) - - ## If this is not specified explicitly, it defaults to 'true'. - generate_package_index: true - - ## This setting is relevant mostly if the standard Python package layout cannot - ## be assumed for 'sphinx-apidoc' invocation. The user can provide the path - ## (relative to the 'package.xml' file) where the Python modules defined by this - ## package are located. - python_source: 'tf2' - - ## This setting, if true, attempts to run `doxygen` and the `breathe`/`exhale` - ## extensions to `sphinx` regardless of build type. This is most useful if the - ## user would like to generate C/C++ API documentation for a package that is not - ## of the `ament_cmake/cmake` build type. - always_run_doxygen: false - - ## This setting, if true, attempts to run `sphinx-apidoc` regardless of build - ## type. This is most useful if the user would like to generate Python API - ## documentation for a package that is not of the `ament_python` build type. - always_run_sphinx_apidoc: false - - # This setting, if provided, will override the build_type of this package - # for documentation purposes only. If not provided, documentation will be - # generated assuming the build_type in package.xml. - # override_build_type: 'ament_python' -builders: - ## Each stanza represents a separate build step, performed by a specific 'builder'. - ## The key of each stanza is the builder to use; this must be one of the - ## available builders. - ## The value of each stanza is a dictionary of settings for the builder that - ## outputs to that directory. - ## Required keys in the settings dictionary are: - ## * 'output_dir' - determines output subdirectory for builder instance - ## relative to --output-directory - ## * 'name' - used when referencing the built docs from the index. - - - doxygen: { - name: 'tf2 Public C/C++ API', - output_dir: 'generated/doxygen' - } - - sphinx: { - name: 'tf2', - ## This path is relative to output staging. - doxygen_xml_directory: 'generated/doxygen/xml', - output_dir: '' - } diff --git a/tf2_bullet/doc/conf.py b/tf2_bullet/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_bullet/doc/conf.py +++ b/tf2_bullet/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_eigen/doc/conf.py b/tf2_eigen/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_eigen/doc/conf.py +++ b/tf2_eigen/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_eigen_kdl/doc/conf.py b/tf2_eigen_kdl/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_eigen_kdl/doc/conf.py +++ b/tf2_eigen_kdl/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_geometry_msgs/doc/conf.py b/tf2_geometry_msgs/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_geometry_msgs/doc/conf.py +++ b/tf2_geometry_msgs/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_kdl/docs/source/conf.py b/tf2_kdl/docs/source/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_kdl/docs/source/conf.py +++ b/tf2_kdl/docs/source/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_msgs/doc/conf.py b/tf2_msgs/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_msgs/doc/conf.py +++ b/tf2_msgs/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_py/doc/conf.py b/tf2_py/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_py/doc/conf.py +++ b/tf2_py/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_ros/doc/conf.py b/tf2_ros/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_ros/doc/conf.py +++ b/tf2_ros/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_ros_py/doc/source/conf.py b/tf2_ros_py/doc/source/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_ros_py/doc/source/conf.py +++ b/tf2_ros_py/doc/source/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_sensor_msgs/doc/conf.py b/tf2_sensor_msgs/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_sensor_msgs/doc/conf.py +++ b/tf2_sensor_msgs/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.' diff --git a/tf2_tools/doc/conf.py b/tf2_tools/doc/conf.py index 440b7a504..1412b83e2 100644 --- a/tf2_tools/doc/conf.py +++ b/tf2_tools/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- from datetime import datetime -now = datetime.now() # current date and time -year = now.strftime("%Y") +now = datetime.now() # current date and time +year = now.strftime('%Y') copyright = '2008-' + year + ', Open Source Robotics Foundation, Inc' # noqa author = 'Open Source Robotics Foundation, Inc.'