WIP

Author: gwaramadze

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Generate Documentation
+
+on:
+  push:
+    branches:
+      - autogenerate-docs
+
+permissions: { }
+
+jobs:
+  generate-docs:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # - uses: actions/setup-python@v5
+      #   with:
+      #     python-version: '3.12'
+      - run: pip install -r docs/build/requirements.txt
+      - run: python build.py
+        working-directory: ./docs/build
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: Update documentation
+          branch: update-documentation
+          delete-branch: true
+          title: 'Update Documentation'
+          body: 'This is the PR with the Autogenerated documentation'
+          labels: 'documentation'

docs/build/build.py

@@ -19,7 +19,9 @@
 )
 renderer = MarkdownRenderer(
     source_linker=GithubSourceLinker(
-        root=LIBRARY_ROOT_PATH.as_posix(), repo="quixio/quix-streams"
+        root=LIBRARY_ROOT_PATH.as_posix(),
+        repo="quixio/quix-streams",
+        use_branch=True,
     ),
     source_position="after signature",
     source_format="[[VIEW SOURCE]]({url})",