Allow no-link option in doxygenpage#748
Conversation
|
@jakobandersen ping. |
|
@michaeljones @jakobandersen any chance we can this moving? Same for the other, more recent PRs. Some folks and I would rather step up and help you guys maintain this repository and not fork or patch downstream. FYI @clalancette @nuclearsandwich. |
|
For some context; we're some of the core maintainers of https://github.com/ros2 , and we've been developing a tool to generate API documentation on our packages. The tool is based on doxygen, breathe, exhale, and sphinx, and you can see the implementation at https://github.com/ros-infrastructure/rosdoc2 . This change, along with #750 and #753 and some fixes in Exhale will allow us to generate the documentation with far fewer errors than before. As @hidmic said, we'd prefer to help maintain this package rather than carry our own fork. Please let us know if you are interested in having maintenance help here. Thanks! |
|
Do you have a small example project (or can make one) where this PR makes a difference? |
PRs are definitely appreciated, and indeed I think having a single project instead of multiple forks is preferable. Though, do note that our maintenance resources are current rather limited, so it may sometimes take a while before we get to each PR. |
|
Hmm, I was unable to put together a minimal example reproducing the issue, and surprisingly enough I cannot reproduce it when building documentation in our project anymore. Perhaps I initially misunderstood the interplay between Breathe, Exhale, and Sphinx when it comes to hyperlinks. @jakobandersen I think we can safely drop this PR. |
|
Closing. |
Precisely what the title says. Whenever using
.. doxygenpage::to pull a Doxygen page into its ownrstdocument, the implicit link to the page may be redundant with that of the title of the document -- necessary for.. toctree::inclusion. That redundancy may cause duplicate ID warnings.This patch allows the user to disable such links.