Add action to publish Doxygen documentation as GH Page #972
Conversation
This file contains hidden or 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
|
Btw, preview can be seen here: https://sven-hoek.github.io/BehaviorTree.CPP/ |
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.
Unfortunately, the docs on the website are quite incomplete regarding the Nodes that come with the library (see issue #649). I didn't see the latest docs hosted anywhere, so this adds a GH Action to build the Doxygen docs and publish it as this repo's GH page.
To have the page actually published, go to this repo's Settings page after the Action has been run at least once. In the sidebar on the left, navigate to Pages, and select Deploy from a branch. Select the
gh-pagesbranch and the/ (root)directory, like so:Now, it should be available under https://BehaviorTree.github.io/BehaviorTree.CPP/ .