upgrading to fix after catkin_pkg API changes #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ver with external Doxygen documentation using tag files
Add ability to configure the doxygen parameter EXTRACT_ALL
|
@hughie our doc build has probably be broken for a while... Please check it, merge this update (you probably should rebase to keep our patch on top) and check again... |
This makes it possible/easier to use a markdown file as mainpage, e.g. the README.md To use it, add a rosdoc.yaml with ``` - builder: doxygen file_patterns: '*.c *.cpp *.h *.cc *.hh *.dox *.md' use_mdfile_as_mainpage: README.md ``` Description of this option from Doxygen: If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that is part of the input, its contents will be placed on the main page (index.html). This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the doxygen output.
add use_mdfile_as_mainpage option
* on recent doxygen topbar requires jquery * fixes documentation generation on ROS melodic * see https://www.stack.nl/~dimitri/doxygen/manual/changelog.html#log_1_8_1
fix top bar on recent doxygen versions
Expose doxygen parameter GENERATE_QHP
use yaml.safe_load for untrusted yaml input
As the result is no longer only relative, the function name is adapted and documentation added.
Update exception handling to Python2.6+ / Python3 syntax
enable linking to documentation hosted on third party server
If -DCATKIN_ENABLE_TESTING=0 is set during cmakeing the call to catkin_add_nosetests(...) fails. This is fixed by checking if testing is enabled
Removes obsolete doxygen options
fix cmake failure when building without tests
backwards-compatible fix for python3 API changes
NOT only USE_MDFILE_AS_MAINPAGE needs to be set, but also the MD file needs to be added to INPUT as mentioned in https://stackoverflow.com/a/13442157
* Use conditional dependencies for all Python rosdep keys * Only depend on epydoc if using Python 2 * Switch to python?-catkin-pkg-modules since the CLI tools aren't used * Python 2 and 3 versions are side-by-side installable * Switch to python?-rospkg-modules since the CLI tools aren't used * Python 2 and 3 versions are side-by-side installable Signed-off-by: Shane Loretz <[email protected]>
Add mdfile to INPUT
fix NameError: global name 'conf' is not defined
Signed-off-by: Shane Loretz <[email protected]>
Bump CMake version to avoid CMP0048
* Removes warning about non existing INCLUDE_PATH. Closes #86
Read include_path from config file
Used by Doxygen for inheritance diagrams.
Add missing graphviz dep
Signed-off-by: Martin Pecka <[email protected]>
… to fail if the builder fails. (#106) * Add option "required" to builder configs which will cause rosdoc_lite to fail if the builder fails. * Require documentation of this package to finish properly. * Added documentation to the added exception from generate_docs.
To enable the treeview set in rosdoc.yaml ``` - builder: doxygen generate_treeview: YES ```
Signed-off-by: Tully Foote <[email protected]>
* fix: failing to import urllib on python3 * test: add tests for prepare_tagfiles
* fix: failing to decode return * refactor: use encoding only for python 3
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.