name: "Docs / Build PR"

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

The docs build instructions have been tested with Sphinx 4 and Fedora 32.

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

For more information, see [Commands](https://sphinx-theme.scylladb.com/stable/commands.html).