Merge pull request #10 from coderpatros/docs

Add initial doc generation and publishing

Author: madpah

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build-documentation:
+    name: "Build documentation"
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@v2
+      - name: Setup Python Environment
+        # see https://github.com/actions/setup-python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: 'x64'
+      - name: Install poetry
+        # see https://github.com/marketplace/actions/setup-poetry
+        uses: Gr1N/setup-poetry@v7
+        with:
+          poetry-version: 1.1.8
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Build documentation
+        run: |
+          poetry run pdoc --html cyclonedx
+      - name: Deploy documentation
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: html/cyclonedx

.gitignore

@@ -18,4 +18,7 @@ venv/*
 
 # Exlude IDE related files
 .idea/*
-.vscode/*
+.vscode/*
+
+# pdoc3 HTML output
+html/

README.md

@@ -126,6 +126,10 @@ outputter = get_instance(bom=bom, schema_version=SchemaVersion.V1_2)
 outputter.output_to_file(filename='/tmp/sbom-v1.2.xml')
 ```
 
+## Library API Documentation
+
+The Library API Documentation is available online at [https://cyclonedx.github.io/cyclonedx-python-lib/](https://cyclonedx.github.io/cyclonedx-python-lib/).
+
 ## Schema Support
 
 This library is a work in progress and complete support for all parts of the CycloneDX schema will come in future releases.

poetry.lock

@@ -43,6 +43,7 @@ requirements_parser = "^0.2.0"
 setuptools = "^50.3.2"
 importlib-metadata = "^4.8.1"
 toml = "^0.10.2"
+pdoc3 = "^0.10.0"
 
 [tool.poetry.dev-dependencies]
 tox = "^3.24.3"