Skip to content

Commit 91095c3

Browse files
alannix-lwAlan Nix
alannix-lw
authored and
Alan Nix
committed
docs: adding pdoc document generation (#84)
1 parent 4919251 commit 91095c3

Some content is hidden

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

56 files changed

+37974
-0
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: docs-website
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
# Build the documentation and upload the static HTML files as an artifact.
13+
build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: actions/setup-python@v3
18+
19+
- run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
20+
- run: if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
21+
- run: SETUPTOOLS_SCM_DEBUG=1 python3 setup.py --version
22+
- run: pdoc laceworksdk --logo https://techally-content.s3-us-west-1.amazonaws.com/public-content/lacework_logo_full.png -o docs/
23+
24+
- uses: actions/upload-pages-artifact@v1
25+
with:
26+
path: docs/
27+
28+
# Deploy the artifact to GitHub pages.
29+
deploy:
30+
needs: build
31+
runs-on: ubuntu-latest
32+
permissions:
33+
pages: write
34+
id-token: write
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
steps:
39+
- id: deployment
40+
uses: actions/deploy-pages@v1

‎docs/index.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="refresh" content="0; url=./laceworksdk.html"/>
6+
</head>
7+
</html>

‎docs/laceworksdk.html‎

Lines changed: 258 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api.html‎

Lines changed: 792 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/base_endpoint.html‎

Lines changed: 718 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/crud_endpoint.html‎

Lines changed: 776 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/search_endpoint.html‎

Lines changed: 491 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/v1.html‎

Lines changed: 248 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/v1/account.html‎

Lines changed: 425 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/laceworksdk/api/v1/compliance.html‎

Lines changed: 984 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)