Skip to content

Modernize conf.py files to only include modified Copyright, eliminati… #865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: rolling
Choose a base branch
from
Open

Modernize conf.py files to only include modified Copyright, eliminati… #865

wants to merge 3 commits into from
+317 −863

Conversation

@rkent
Copy link
Contributor

@rkent rkent commented Nov 27, 2025

Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later

Description

Replace or creates a conf.py in each package in this repo, that only generates a custom Copyright notice.

Modern rosdoc2 requires nothing in a user-supplied conf.py, so any additions should be intended to modify standard rosdoc2 behavior. As far as I can tell, the only intentional change to standard rosdoc2 behavior in this repo was to provide a more detailed copyright notice.

Remove cruft such as:

  • old stuff that used to be required by rosdoc2 in a custom conf.py
  • various configurations of documentation systems (like Latex) that are not used in current ROS 2 documentation infrastructure (See discussion in Fix errors in documentation generation. #833)
  • including additional sphinx extensions that, AFAICT, are not actually used by the current geometry2 documentation generation

What remains is an identical conf.py file in each package that generates the custom copyright notice. In some cases this involved modifying an existing conf.py, in others a new conf.py was included.

Package tf2_kdl uses a custom documentation folder name that is not being picked up by rosdoc2. So although this PR includes the new conf.py, until tf2_kdl is modified this is not actually affecting the documentation generation. This will be fixed in a future PR.

Review should confirm that the generated copyright notice is indeed what is desired. The notice is:
© Copyright 2008-2025, Open Source Robotics Foundation, Inc.

Hopefully I have not misunderstood the intentions of existing conf.py files, but they appear to me to be mostly automatically-generated boilerplate that really is not needed.

Partially addresses #833

Is this user-facing behavior change?

No, only documentation.

Did you use Generative AI?

See header.

@rkent
Modernize conf.py files to only include modified Copyright, eliminati…
19a4eaa 
…ng cruft.

Signed-off-by: R Kent James <[email protected]>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
ahcorde
ahcorde requested changes Nov 27, 2025
View reviewed changes
examples_tf2_py/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

test_tf2/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_bullet/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_eigen/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_eigen_kdl/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_msgs/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_py/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_ros_py/doc/source/conf.py Outdated
@@ -1,5 +1,4 @@

# Copyright 2023 Open Source Robotics Foundation, Inc.
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2023 Open Source Robotics Foundation, Inc.

tf2_sensor_msgs/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

tf2_tools/doc/conf.py Outdated
@@ -0,0 +1,27 @@
# Copyright 2024 Open Source Robotics Foundation, Inc.
Copy link
Contributor

@ahcorde ahcorde Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Copyright 2024 Open Source Robotics Foundation, Inc.
# Copyright 2025 Open Source Robotics Foundation, Inc.

@rkent
Update copyright date to 2025 in conf.py
3d68c1d 
Signed-off-by: R Kent James <[email protected]>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
@rkent
Copy link
Contributor Author

rkent commented Dec 2, 2025

I replaced all of the copyright dates to 2025 in a single commit.

@ahcorde
Copy link
Contributor

ahcorde commented Dec 2, 2025

Pulls: #865
Gist: https://gist.githubusercontent.com/ahcorde/252ae228aa176c4e9c72980756015a32/raw/9d04f37fb52c49dae6d10eefc8b49f9aa2fb989c/ros2.repos
BUILD args: --packages-above-and-dependencies examples_tf2_py test_tf2 tf2 tf2_bullet tf2_eigen tf2_eigen_kdl tf2_geometry_msgs tf2_kdl tf2_py tf2_ros tf2_ros_py tf2_sensor_msgs tf2_tools
TEST args: --packages-above examples_tf2_py test_tf2 tf2 tf2_bullet tf2_eigen tf2_eigen_kdl tf2_geometry_msgs tf2_kdl tf2_py tf2_ros tf2_ros_py tf2_sensor_msgs tf2_tools
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/17659

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Linux-rhel Build Status
  • Windows Build Status

ahcorde
ahcorde requested changes Dec 2, 2025
View reviewed changes
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some linters failing https://build.ros2.org/job/Rpr__geometry2__ubuntu_noble_amd64/350/

@rkent
Fix flake errors in conf.py; delete inadvertently added file from pre…
36997b1 
…vious commit

Signed-off-by: R Kent James <[email protected]>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
@rkent
Copy link
Contributor Author

rkent commented Dec 2, 2025

OK I fixed the flake errors. Not sure why you saw them now but not previously, as the code in question was copied from an existing conf.py. I also deleted a file I'd added inadvertently in a previous PR.

The auto build with this PR fails, not sure why that is, the error makes no sense with my changes.

@ahcorde
Copy link
Contributor

ahcorde commented Dec 3, 2025

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Linux-rhel Build Status
  • Windows Build Status

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ahcorde ahcorde ahcorde requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rkent @ahcorde