Skip to content

Commit 8feeb20

Browse files
dgarcia360avelanarius
authored andcommitted
docs: update theme 1.2
docs: update dynamic slug Add back index.md Move custom slug to a separate PR Fix typo
1 parent 89cb49a commit 8feeb20

12 files changed

+174
-265
lines changed

.github/workflows/docs-pages.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "Docs / Publish"
2+
# For more information,
3+
# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
4+
5+
on:
6+
push:
7+
branches:
8+
- scylla-3.x
9+
paths:
10+
- 'docs/**'
11+
- 'faq/**'
12+
- 'manual/**'
13+
- 'changelog/**'
14+
- 'upgrade_guide/**'
15+
workflow_dispatch:
16+
17+
jobs:
18+
release:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v3
23+
with:
24+
persist-credentials: false
25+
fetch-depth: 0
26+
- name: Set up Python
27+
uses: actions/setup-python@v3
28+
with:
29+
python-version: 3.7
30+
- name: Set up JDK 1.8
31+
uses: actions/setup-java@v1
32+
with:
33+
java-version: 1.8
34+
- name: Set up env
35+
run: make -C docs setupenv
36+
- name: Build docs
37+
run: make -C docs multiversion
38+
- name: Deploy docs to GitHub Pages
39+
run: ./docs/_utils/deploy.sh
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs-pages@v2.yaml

Lines changed: 0 additions & 37 deletions
This file was deleted.

.github/workflows/docs-pr.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "Docs / Build PR"
2+
# For more information,
3+
# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
4+
5+
on:
6+
pull_request:
7+
branches:
8+
- scylla-3.x
9+
paths:
10+
- 'docs/**'
11+
- 'faq/**'
12+
- 'manual/**'
13+
- 'changelog/**'
14+
- 'upgrade_guide/**'
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v3
22+
with:
23+
persist-credentials: false
24+
fetch-depth: 0
25+
- name: Set up Python
26+
uses: actions/setup-python@v3
27+
with:
28+
python-version: 3.7
29+
- name: Set up JDK 1.8
30+
uses: actions/setup-java@v1
31+
with:
32+
java-version: 1.8
33+
- name: Set up env
34+
run: make -C docs setupenv
35+
- name: Build docs
36+
run: make -C docs test

.github/workflows/docs-pr@v1.yaml

Lines changed: 0 additions & 29 deletions
This file was deleted.

README-dev.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Building the docs
2+
3+
The docs build instructions have been tested with Sphinx 4 and Fedora 32.
4+
5+
## Prerequisites
6+
7+
To build and preview the docs locally, you will need to install the following software:
8+
9+
- Git
10+
- Python 3.7
11+
- pip
12+
- Java JDK 8 or above
13+
- Maven
14+
15+
## Commands
16+
17+
For more information, see [Commands](https://sphinx-theme.scylladb.com/stable/commands.html).

README-dev.rst

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs.yaml

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)