Merge pull request #268 from EasyPost/ci_docs

chore: generate docs on CI
EasyPost · May 1, 2023 · bf2f9bb · bf2f9bb
2 parents 0f3a2ef + 7ef8e79
commit bf2f9bb
Show file tree

Hide file tree

Showing 42 changed files with 24 additions and 17,599 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-name: "CI"
+name: 'CI'
 
 on:
   push:
@@ -14,7 +14,7 @@ jobs:
       - name: set up python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: '3.11'
       - name: Install Dependencies
         run: make install
       - name: Check format
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-20.04 # TODO: Python 3.6 doesn't have a binary for 22.04, switch to `latest` once we drop support for Python 3.6
     strategy:
       matrix:
-        pythonversion: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+        pythonversion: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11']
     steps:
       - uses: actions/checkout@v3
       - name: set up python
@@ -41,3 +41,22 @@ jobs:
         run: venv/bin/coveralls --service=github
       - name: Run security analysis
         run: make scan
+  docs:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install Dependencies
+        run: make install
+      - name: Generate Docs
+        run: make docs
+      - name: Deploy Docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
diff --git a/.gitignore b/.gitignore
@@ -18,7 +18,7 @@
 *.sublime-*
 /MANIFEST
 dist
-docs/build/
+docs
 Icon
 test
 venv

diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ print(shipment)
 
 API documentation can be found at: <https://easypost.com/docs/api>.
 
-Library documentation can be found on the web at: <https://easypost.github.io/easypost-python/> or locally in the `docs` directory.
+Library documentation can be found on the web at: <https://easypost.github.io/easypost-python/> or by building them locally via the `make docs` command.
 
 Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md).
 

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/api_key.html b/docs/easypost/api_key.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/payload.html b/docs/easypost/payload.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
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ @@
     *.sublime-*
     /MANIFEST
     dist
-    docs/build/
+    docs
     Icon
     test
     venv
@@ Expand Down @@