ros2 / ros2/geometry2

Fix errors in documentation generation.

Open
#833 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
153
Forks
256
Avg merge
3d 23h
Merged PRs (30d)
14

Description

I'm currently going through this repository, fixing errors in rosdoc2 documentation generation, starting with the tf2 package.

But I have a question (if anyone is listening!).

The conf.py in tf2 has a lot of extra, unneeded stuff, and I would like to remove the cruft. The stuff added for rosdoc2 I understand. But my question is this:

Is there any need to support other other modes of documentation generation, beyond rosdoc2? For example, there is code there that is only useful for one or more of the following documentation generations: htmlhelp, latex, man_pages, texinfo, or epub. None of these are needed for rosdoc2 generation.

The changes that are needed go beyond fixing the cruft in conf.py. For example, Vector3 is not documented due to a configuration error that I can fix. But the immediate question concerns the non-rosdoc2 cruft.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the tf2 package's conf.py and the rosdoc2 documentation-generation setup. Check which listed output modes are supported or required, then verify the Vector3 documentation configuration; done means the relevant cruft is removed without breaking rosdoc2 generation and Vector3 appears correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.