1. Copy the
.github directories from the repository scylladb/sphinx-scylladb-theme
to the project root directory where you want to setup docs. The directory structure should look like this:
project-name/ ├── pyproject.toml ├── .github/workflows/pages.yml ├── docs/ │ ├── _utils/ │ | ├── deploy.sh │ | ├── redirect.sh │ | ├── setup.sh │ ├── source/ │ ├── Makefile
If you already have docs in the project under an existing
docs directory, move the doc files to the
Create the file
docs/pyproject.tomlunder the new
docsfolder. Copy the contents from the pyproject.toml template.
Edit the project’s
conf.pyfile to suit the project needs (e.g. install new extensions, edit navigation links, …). For more information about the most common configurable settings, refer to Configuration.
If you don’t already have a
.gitignorefile in the project, place one in the root directory and include
/source/.doctreesin it. If you already have a
.gitignorefile, add both paths to the file.