scylladb · psarna · Feb 9, 2022 · Feb 9, 2022
diff --git a/.github/workflows/docs-pages.yaml b/.github/workflows/docs-pages.yaml
@@ -0,0 +1,31 @@
+name: "Docs / Publish"
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: 3.7
+      - name: Set up Poetry
+        run: curl -sSL https://install.python-poetry.org | python -
+      - name: Build docs
+        run: make -C docs multiversion
+      - name: Deploy docs to GitHub Pages
+        run: ./docs/_utils/deploy.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/[email protected] b/.github/workflows/[email protected]
diff --git a/.github/workflows/docs-pr.yaml b/.github/workflows/docs-pr.yaml
@@ -0,0 +1,26 @@
+name: "Docs / Build PR"
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: 3.7
+      - name: Set up Poetry
+        run: curl -sSL https://install.python-poetry.org | python -
+      - name: Build docs
+        run: make -C docs test
diff --git a/.github/workflows/[email protected] b/.github/workflows/[email protected]
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,5 +1,5 @@
 # You can set these variables from the command line.
-POETRY        = $(HOME)/.poetry/bin/poetry
+POETRY        = $(HOME)/.local/bin/poetry
 SPHINXOPTS    =
 SPHINXBUILD   = $(POETRY) run sphinx-build
 PAPER         =
@@ -24,7 +24,8 @@ pristine: clean
 
 .PHONY: setup
 setup:
-	./_utils/setup.sh
+	$(POETRY) install
+	$(POETRY) update
 
 .PHONY: clean
 clean:
@@ -70,14 +71,13 @@ linkcheck: setup
 
 .PHONY: multiversion
 multiversion: setup
-	@mkdir -p $(HOME)/.cache/pypoetry/virtualenvs
 	$(POETRY) run sphinx-multiversion source _build/dirhtml
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
 .PHONY: multiversionpreview
 multiversionpreview: multiversion
-	$(POETRY) run python3 -m http.server 5500 --directory $(BUILDDIR)/dirhtml
+	$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
 
 .PHONY: test
 test: setup

diff --git a/docs/_utils/pyproject_template.toml b/docs/_utils/pyproject_template.toml
diff --git a/docs/_utils/setup.sh b/docs/_utils/setup.sh
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -6,17 +6,14 @@ authors = ["ScyllaDB Documentation Contributors"]
 
 [tool.poetry.dependencies]
 python = "^3.7"
-pyyaml = "5.3"
-pygments = "2.8.0"
-recommonmark = "0.5.0"
-sphinx-scylladb-theme = "~1.0.0"
+pyyaml = "^6.0"
+pygments = "2.11.2"
+recommonmark = "^0.7.1"
+sphinx-scylladb-theme = "~1.1.0"
 sphinx-sitemap = "2.1.0"
-sphinx-autobuild = "0.7.1"
-Sphinx = "2.4.4"
-sphinx-multiversion-scylla = "~0.2.6"
-
-[tool.poetry.dev-dependencies]
-pytest = "5.2"
+sphinx-autobuild = "^2021.3.14"
+Sphinx = "^4.3.2"
+sphinx-multiversion-scylla = "~0.2.10"
 
 [build-system]
 requires = ["poetry>=0.12"]

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -5,6 +5,7 @@
 
 import recommonmark
 from recommonmark.transform import AutoStructify
+from pygments.lexers.configs import TOMLLexer
 from pygments.lexers.rust import RustLexer
 from sphinx.highlighting import lexers
 
@@ -49,9 +50,6 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
 # Setup Sphinx
 def setup(sphinx):
     sphinx.add_config_value('recommonmark_config', {
@@ -60,6 +58,7 @@ def setup(sphinx):
     }, True)
     sphinx.add_transform(AutoStructify)
     lexers['rust'] = RustLexer()
+    lexers['toml'] = TOMLLexer()
 
 
 # -- Options for not found extension -------------------------------------------
@@ -110,7 +109,6 @@ def setup(sphinx):
     'default_branch': 'main',
     'github_repository': 'scylladb/scylla-rust-driver',
     'github_issues_repository': 'scylladb/scylla-rust-driver',
-    'hide_sidebar_index': 'false',
     'hide_banner': 'true',
     'site_description': 'Scylla Driver for Rust.',
     'hide_edit_this_page_button': 'false'