forked from scylladb/java-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update dynamic slug Add back index.md Move custom slug to a separate PR Fix typo
- Loading branch information
1 parent
89cb49a
commit 8feeb20
Showing
12 changed files
with
174 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 }} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.