Skip to content

change docs file structure to work with recent rosdoc2 #930

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

Open
ottojo wants to merge 3 commits into
base: kilted
Choose a base branch
from
+29 −58
Open

change docs file structure to work with recent rosdoc2 #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e98320a
fix docs file structure to work with recent rosdoc2
ottojo Nov 22, 2025
9ba95e2
index.rst: remove superfluous newline
ottojo Feb 2, 2026
f119c49
add redirect from doc/source/architecture.html
ottojo Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion launch/doc/.gitignore
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions launch/doc/Makefile
View file
Open in desktop

This file was deleted.

0 launch/doc/source/architecture.rst → launch/doc/architecture.rst
View file
Open in desktop
File renamed without changes.
0 launch/doc/source/conf.py → launch/doc/conf.py
View file
Open in desktop
File renamed without changes.
10 changes: 10 additions & 0 deletions launch/doc/doc/source/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Architecture of `launch` (redirect)
===================================

Redirecting to `h../../architecture.html <../../architecture.html>`_...

.. raw:: html

<script type="text/javascript">
window.location.href = '../../architecture.html'
</script>
13 changes: 12 additions & 1 deletion launch/doc/source/index.rst → launch/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,20 @@ Welcome to launch's documentation!
:caption: Contents:

architecture
modules
Links <__links>
Python API <modules>
Standard Documents <__standards>
ROS Package Dependencies <__ros_package_dependencies>
Copy link
Contributor

@ahcorde ahcorde Nov 28, 2025

Choose a reason for hiding this comment

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

I can see this error

WARNING: toctree contains reference to nonexisting document '__ros_package_dependencies' [toc.not_readable]

Copy link
Contributor Author

@ottojo ottojo Nov 28, 2025

Choose a reason for hiding this comment

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

I can't reproduce this, is this on the buildfarm or locally for you? This probably happens with a (perhaps just slightly) out of date rosdoc2, as this only got merged recently: ros-infrastructure/rosdoc2#205

Copy link
Contributor

@ahcorde ahcorde Dec 1, 2025

Choose a reason for hiding this comment

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

I'm running version rosdoc2 0.2.2.dev0, I used a virtual env to install rosdoc2 with the latest changes but I can't see this directory.

I'm using this cmd:

rosdoc2 build   --package-path ./src/ros2/launch/launch

Copy link
Contributor Author

@ottojo ottojo Feb 2, 2026

Choose a reason for hiding this comment

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

i could reproduce the same warning with rosdoc2 installed via the python3-rosdoc2 apt package on kilted (after making this change in the rosdoc2 yaml, which is not required in a more recent version).

diff --git a/launch/rosdoc2.yaml b/launch/rosdoc2.yaml
index d2f5855..c243fe9 100644
--- a/launch/rosdoc2.yaml
+++ b/launch/rosdoc2.yaml
@@ -3,4 +3,4 @@ version: 1
 ---
 settings: {}
 builders:
-  - sphinx: { sphinx_sourcedir: "doc" }
+  - sphinx: { name: "launch", output_dir: "", sphinx_sourcedir: "doc" }

I'm not sure how to proceed here, to me this looks to me like a rosdoc2 version issue, unfortunately the version has not been bumped in 2 years despite significant changes (https://github.com/ros-infrastructure/rosdoc2/blob/main/rosdoc2/__init__.py#L15)



Indices and tables
ROS Package Dependencies <__ros_package_dependencies>

.. toctree::
:hidden:

doc/source/architecture

Indices and tables
==================

Expand Down
36 changes: 0 additions & 36 deletions launch/doc/make.bat
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions launch/package.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@

<export>
<build_type>ament_python</build_type>
<rosdoc2>rosdoc2.yaml</rosdoc2>
</export>
</package>
6 changes: 6 additions & 0 deletions launch/rosdoc2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
type: "rosdoc2 config"
version: 1
---
settings: {}
builders:
- sphinx: { sphinx_sourcedir: "doc" }