FREE Virtual Training Event | April 22, 2021
Register Now >

Caution

You are reading an unstable version of this documentation. If you want up-to-date information, please have a look at 0.1.21 .

Installation

1. Copy the docs and .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

Note

If you already have docs in the project under an existing docs directory, move the doc files to the docs/source directory.

  1. Create the file docs/pyproject.toml under the new docs folder. Copy the contents from the pyproject.toml template.

  2. Edit the project’s conf.py file 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.

  3. If you don’t already have a .gitignore file in the project, place one in the root directory and include /docs/_build and /source/.doctrees in it. If you already have a .gitignore file, add both paths to the file.