Feat: Generate api documentation and host as github page #156
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
package.json - adds typedoc lib and build:doc script to generate api docs to a ./doc folder README.md - added a URL link to the git page where api docs are deployed.
ros2jsguy
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
As a quick experiment I recently forked this repo solely to generate and host the api docs. The docs look pretty good (https://ros2jsguy.github.io/blueshell-docs/). This PR proposes to rehome that small bit of work to the main repo. The commit will generate the api docs in html format. In addition, a user with admin privileges to this repo will need to enable github pages (under settings menu) on the repo and point to deployment folder, (./docs).
package.json
README.md