Merge pull request #242 from EasyPost/docs

feat: adds library documentation
EasyPost · Nov 3, 2022 · 78f3c82 · 78f3c82
2 parents 8fcecf6 + 205ed15
commit 78f3c82
Show file tree

Hide file tree

Showing 41 changed files with 16,466 additions and 9 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,9 @@
 * text=auto
 
+# Cassettes
 tests/cassettes/* -diff
 tests/cassettes/* linguist-generated
+
+# Docs
+docs/**/* -diff
+docs/**/* linguist-generated
diff --git a/Makefile b/Makefile
@@ -8,6 +8,14 @@ TEST_DIR := tests
 help:
 	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
 
+## black - Runs the Black Python formatter against the project
+black:
+	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/
+
+## black-check - Checks if the project is formatted correctly against the Black rules
+black-check:
+	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/ --check
+
 ## build - Builds the project in preparation for release
 build:
 	$(VIRTUAL_BIN)/python setup.py sdist bdist_wheel
@@ -21,13 +29,9 @@ clean:
 coverage:
 	$(VIRTUAL_BIN)/pytest --cov=$(PROJECT_NAME) --cov-branch --cov-report=html --cov-report=term-missing --cov-fail-under=87
 
-## black - Runs the Black Python formatter against the project
-black:
-	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/
-
-## black-check - Checks if the project is formatted correctly against the Black rules
-black-check:
-	$(VIRTUAL_BIN)/black $(PROJECT_NAME)/ $(TEST_DIR)/ --check
+## docs - Generates docs for the library
+docs:
+	$(VIRTUAL_BIN)/pdoc $(PROJECT_NAME) -o docs
 
 ## format - Runs all formatting tools against the project
 format: black isort
@@ -75,4 +79,4 @@ scan:
 test:
 	$(VIRTUAL_BIN)/pytest
 
-.PHONY: help build clean coverage black black-check format format-check install isort isort-check lint mypy publish release scan test
+.PHONY: help black black-check build clean coverage docs format format-check install isort isort-check lint mypy publish release scan test
diff --git a/README.md b/README.md
@@ -89,6 +89,9 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
 # Run security analysis
 make scan
 
+# Generate library documentation
+make docs
+
 # Update submodules
 git submodule init
 git submodule update --remote

diff --git a/docs/easypost.html b/docs/easypost.html
diff --git a/docs/easypost/address.html b/docs/easypost/address.html
diff --git a/docs/easypost/batch.html b/docs/easypost/batch.html
diff --git a/docs/easypost/beta.html b/docs/easypost/beta.html
diff --git a/docs/easypost/beta/referral.html b/docs/easypost/beta/referral.html
diff --git a/docs/easypost/billing.html b/docs/easypost/billing.html
diff --git a/docs/easypost/brand.html b/docs/easypost/brand.html
diff --git a/docs/easypost/carrier_account.html b/docs/easypost/carrier_account.html
diff --git a/docs/easypost/constant.html b/docs/easypost/constant.html
diff --git a/docs/easypost/customs_info.html b/docs/easypost/customs_info.html
diff --git a/docs/easypost/customs_item.html b/docs/easypost/customs_item.html
diff --git a/docs/easypost/easypost_object.html b/docs/easypost/easypost_object.html
diff --git a/docs/easypost/endshipper.html b/docs/easypost/endshipper.html
diff --git a/docs/easypost/error.html b/docs/easypost/error.html
diff --git a/docs/easypost/event.html b/docs/easypost/event.html
diff --git a/docs/easypost/insurance.html b/docs/easypost/insurance.html
diff --git a/docs/easypost/order.html b/docs/easypost/order.html
diff --git a/docs/easypost/parcel.html b/docs/easypost/parcel.html
diff --git a/docs/easypost/pickup.html b/docs/easypost/pickup.html
diff --git a/docs/easypost/pickup_rate.html b/docs/easypost/pickup_rate.html
diff --git a/docs/easypost/postage_label.html b/docs/easypost/postage_label.html
diff --git a/docs/easypost/rate.html b/docs/easypost/rate.html
diff --git a/docs/easypost/referral.html b/docs/easypost/referral.html
diff --git a/docs/easypost/refund.html b/docs/easypost/refund.html
diff --git a/docs/easypost/report.html b/docs/easypost/report.html
diff --git a/docs/easypost/requestor.html b/docs/easypost/requestor.html
diff --git a/docs/easypost/resource.html b/docs/easypost/resource.html
diff --git a/docs/easypost/scanform.html b/docs/easypost/scanform.html
diff --git a/docs/easypost/shipment.html b/docs/easypost/shipment.html
diff --git a/docs/easypost/tax_identifier.html b/docs/easypost/tax_identifier.html
diff --git a/docs/easypost/tracker.html b/docs/easypost/tracker.html
diff --git a/docs/easypost/user.html b/docs/easypost/user.html
diff --git a/docs/easypost/util.html b/docs/easypost/util.html
diff --git a/docs/easypost/version.html b/docs/easypost/version.html
diff --git a/docs/easypost/webhook.html b/docs/easypost/webhook.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/setup.py b/setup.py
@@ -16,10 +16,11 @@
     "flake8==5.*",
     "isort==5.*",
     "mypy==0.971",
+    "pdoc==12.*;python_version>='3.7'",
     "pytest-cov==3.*",
     "pytest-vcr==1.*",
     "pytest==7.*",
-    "twine==3.8.*",  # Twine 4.0+ drops support for Python 3.6
+    "twine==3.8.*",  # Twine 4.0 drops support for Python 3.6
     "types-requests",
     "types-urllib3",
     "vcrpy==4.*",