Skip to content

Feat: Generate api documentation and host as github page #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ros2jsguy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feat: Generate api documentation and host as github page #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ Decorators intercept and can modify the event sent to or the result from the chi

* The publisher can be registered with the tree which will log each transition.

## API Documentation
You can find the latest Blueshell api documentation [here](https://6RiverSystems.github.io/blueshell/).

## Inspiration and Further Reading

The following are sources used when designing this library
Expand Down
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
],
"scripts": {
"build": "npm-run-all build:js",
"build:docs": "typedoc -out ./docs --githubPages true --hideGenerator true --cleanOutputDir true --entryPoints ./index.ts",
"build:js": "tsc --pretty",
"build:watch": "tsc --pretty --watch",
"pretest": "npm-run-all build pretest:eslint",
Expand Down Expand Up @@ -52,9 +53,9 @@
"@types/reflect-metadata": "0.1.0",
"@types/sinon": "7.0.2",
"@types/uuid": "3.4.4",
"@types/ws": "7.2.1",
"@typescript-eslint/eslint-plugin": "4.28.5",
"@typescript-eslint/parser": "4.28.5",
"@types/ws": "7.2.1",
"chai": "4.2.0",
"chai-as-promised": "7.1.1",
"codecov": "3.8.2",
Expand All @@ -70,7 +71,7 @@
"npm-run-all": "4.1.5",
"nyc": "15.0.0",
"sinon": "7.3.2",
"typedoc": "^0.22.6",
"typedoc": "^0.22.18",
"typescript": "~4.3.5",
"validate-commit-msg": "2.14.0"
},
Expand Down