docs: Add docs markdown builds

qctrl · May 15, 2024 · b2aea1f · b2aea1f
1 parent 545f75a
commit b2aea1f
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 3 deletions.
diff --git a/.github/workflows/on-release.yaml b/.github/workflows/on-release.yaml
@@ -29,6 +29,19 @@ jobs:
       run: |
         ./ci docker run qctrl/ci-images:python-3.11-ci /scripts/publish-release-internally.sh
 
+  update_documentation:
+    if: false # This job is disabled until https://qctrl.atlassian.net/browse/ACC-386 is resolved
+    runs-on: ubuntu-latest
+    container: qctrl/ci-images:python-3.11-ci
+    steps:
+      - name: Update docs repo
+        uses: qctrl/reusable-workflows/.github/actions/docs/update-docs@master
+        with:
+          source_branch: master
+          target_branch: master
+          vault-role-id: ${{ secrets.VAULT_ROLE_ID }}
+          vault-secret-id: ${{ secrets.VAULT_SECRET_ID }}
+
   sphinx_documentation:
     runs-on: ubuntu-latest
     steps:

diff --git a/docs/conf.py b/docs/conf.py
@@ -60,6 +60,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
+    "sphinx_markdown_builder",
 ]
 
 master_doc = "index"

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,7 @@ pytest = "^8.0.0"
 qctrl-sphinx-theme = "^2.1.4"
 sphinx = "^5.0.0"
 tomli = "^2.0.1"
+sphinx-markdown-builder = "^0.6.6"
 
 [tool.poetry.urls]
 GitHub = "https://github.com/qctrl"