WIP

Author: johann-petrak

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -2,5 +2,6 @@
 
 Python package `llms_wrapper`
 
-* [Documentation wiki](https://github.com/OFAI/python-llms-wrapper/wiki)
-* [Python API Documentation](https://ofai.github.io/python-llms-wrapper/llms_wrapper/)
+Documentation: 
+
+**IMPORTANT:** This is still under development, API may change and the documentation is still work in progress!

docs/_notes.txt

@@ -11,5 +11,7 @@ Github help:
 * Customize theme: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll
 
 
+Install:
+* See https://jekyllrb.com/docs/installation/ubuntu/
 Test locally: see theme readme, https://github.com/pages-themes/cayman
 Then run: bundle exec jekyll serve

docs/index.md

@@ -1,5 +1,7 @@
 # python-llms-wrapper
 
+**IMPORTANT** This is still work in progress! API may change and documentation is still work in progress!
+
 The `llms_wrapper` Python package is an opnionated library based on the excellen 
 [`litelmm`](https://github.com/BerriAI/litellm) package to simplify using diverse
 LLMs from many different providers. 

docs/usage.md

@@ -1 +1 @@
-The full API documentation is available here: https://ofai.github.io/python-llms-wrapper/llms_wrapper/
+TBD!