feat: Add support for new search with Algolia (#281)

qctrl · Aug 3, 2023 · 12644a1 · 12644a1
1 parent 9507647
commit 12644a1
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 15 deletions.
diff --git a/.github/workflows/on-release.yaml b/.github/workflows/on-release.yaml
@@ -33,11 +33,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Retrieve segment write key (Production)
+      - name: Retrieve build-time environment variables (Production)
         run: |
           source <(curl -sL http://ci.q-ctrl.com)
           ./ci vault login -r ${{ secrets.VAULT_ROLE_ID }} -s ${{ secrets.VAULT_SECRET_ID }}
           ./ci vault get -k SEGMENT_WRITE_KEY -t $(cat .token) -p secret/data/python/prod -o ./docs/SEGMENT_WRITE_KEY
+          ./ci vault get -k DOCSEARCH_APP_ID -t $(cat .token) -p secret/data/python/prod -o ./docs/DOCSEARCH_APP_ID
+          ./ci vault get -k DOCSEARCH_API_KEY -t $(cat .token) -p secret/data/python/prod -o ./docs/DOCSEARCH_API_KEY
+          ./ci vault get -k DOCSEARCH_INDEX_NAME -t $(cat .token) -p secret/data/python/prod -o ./docs/DOCSEARCH_INDEX_NAME
       - name: Build Sphinx Image and Push to DockerHub
         run: |
           ./ci vault get -t $(cat .token) -p secret/data/dockerhub -k hub_user -o .hub_user

diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -9,6 +9,9 @@ RUN /scripts/install-python-dependencies.sh
 WORKDIR /docs
 
 RUN SEGMENT_WRITE_KEY=$([ -f SEGMENT_WRITE_KEY ] && cat SEGMENT_WRITE_KEY) \
+    DOCSEARCH_APP_ID=$([ -f DOCSEARCH_APP_ID ] && cat DOCSEARCH_APP_ID) \
+    DOCSEARCH_API_KEY=$([ -f DOCSEARCH_API_KEY ] && cat DOCSEARCH_API_KEY) \
+    DOCSEARCH_INDEX_NAME=$([ -f DOCSEARCH_INDEX_NAME ] && cat DOCSEARCH_INDEX_NAME) \
     poetry run make html
 
 FROM qctrl/ci-images:nginx-base

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,7 @@
 from typing import List
 
 import tomli
+from qctrlsphinxtheme import get_html_theme_options
 
 import qctrlopencontrols
 
@@ -81,15 +82,7 @@
 html_theme = "qctrl_sphinx_theme"
 
 # Theme options
-html_theme_options = {
-    # Toc options
-    "collapse_navigation": False,
-    "includehidden": False,
-}
-
-segment_write_key = os.getenv("SEGMENT_WRITE_KEY", "")
-if segment_write_key != "":
-    html_theme_options["segment_write_key"] = segment_write_key
+html_theme_options = get_html_theme_options()
 
 # Option to automatically generate summaries.
 autosummary_generate = True

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,7 +71,7 @@ mypy = "^1.4.1"
 pre-commit = "^3.3.3"
 pylint = "^2.17.4"
 pytest = "^7.4.0"
-qctrl-sphinx-theme = "~0.2.0"
+qctrl-sphinx-theme = "~1.0.1"
 sphinx = "^5.0.0"
 tomli = "^2.0.1"