Skip to content

Commit b103129

Browse files
committed
feat: adds docs to the library
1 parent ff05b25 commit b103129

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+29212
-7
lines changed

.gitattributes

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
* text=auto
22

3+
# Cassettes
34
*.har -diff
45
*.har linguist-generated
6+
7+
# Docs
8+
docs/**/* -diff
9+
docs/**/* linguist-generated

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ clean:
1414
coverage:
1515
npm run coverage
1616

17+
## docs - Generate docs for the library
18+
docs:
19+
npm run docs
20+
1721
## fix - Fix linting errors
1822
fix:
1923
npm run fix
@@ -60,4 +64,4 @@ update:
6064
git submodule update --remote
6165
npm update
6266

63-
.PHONY: help build clean coverage fix format format-check install lint publish release scan test update
67+
.PHONY: help build clean coverage docs fix format format-check install lint publish release scan test update

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
195195
# Run security analysis
196196
make scan
197197

198+
# Generate library documentation
199+
make docs
200+
198201
# Update submodules
199202
git submodule init
200203
git submodule update --remote

docs/address.js.html

Lines changed: 139 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api_key.js.html

Lines changed: 112 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)