docs: update theme 1.2

docs: update dynamic slug

Add back index.md

Move custom slug to a separate PR

Fix typo

.github/workflows/docs-pages.yaml

@@ -0,0 +1,41 @@
+name: "Docs / Publish"
+# For more information,
+# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
+
+on:
+ push:
+ branches:
+ - scylla-3.x
+ paths:
+ - 'docs/**'
+ - 'faq/**'
+ - 'manual/**'
+ - 'changelog/**'
+ - 'upgrade_guide/**'
+ workflow_dispatch:
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ persist-credentials: false
+ fetch-depth: 0
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: 3.7
+ - name: Set up JDK 1.8
+ uses: actions/setup-java@v1
+ with:
+ java-version: 1.8
+ - name: Set up env
+ run: make -C docs setupenv
+ - 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 }}

.github/workflows/docs-pr.yaml

@@ -0,0 +1,36 @@
+name: "Docs / Build PR"
+# For more information,
+# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
+
+on:
+ pull_request:
+ branches:
+ - scylla-3.x
+ paths:
+ - 'docs/**'
+ - 'faq/**'
+ - 'manual/**'
+ - 'changelog/**'
+ - 'upgrade_guide/**'
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ persist-credentials: false
+ fetch-depth: 0
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: 3.7
+ - name: Set up JDK 1.8
+ uses: actions/setup-java@v1
+ with:
+ java-version: 1.8
+ - name: Set up env
+ run: make -C docs setupenv
+ - name: Build docs
+ run: make -C docs test

README-dev.md

@@ -0,0 +1,17 @@
+# Building the docs
+
+The docs build instructions have been tested with Sphinx 4 and Fedora 32.
+
+## Prerequisites
+
+To build and preview the docs locally, you will need to install the following software:
+
+- Git
+- Python 3.7
+- pip
+- Java JDK 8 or above
+- Maven
+
+## Commands
+
+For more information, see [Commands](https://sphinx-theme.scylladb.com/stable/commands.html).