feat: add pdoc support (#6)

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Publish Docs
+
+on: workflow_dispatch
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+
+      - name: Set up pdoc
+        run:  pip install pdoc3
+
+      - name: Setup Docs
+        run:  pdoc ./src/amplitude_experiment -o ./docs --html
+
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs/amplitude_experiment

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/amplitude_experiment
 
 # PyBuilder
 target/

src/amplitude_experiment/__init__.py

@@ -1,4 +1,7 @@
-"""The official Amplitude Experiment Python Server SDK"""
+"""
+The official Amplitude Experiment Python Server SDK
+.. include:: ../../README.md
+"""
 
 from .client import Client
 from .config import Config