GitHub Pages

The theme uses GitHub Pages and GitHub Actions to make the documentation publicly available.

Most projects build and deploy a new site every time the default branch (master) receives an update. When multiversion is enabled, GitHub Pages builds docs for all versions listed in the file conf.py.

Enabling GitHub Pages

  1. Create a file named .github/pages.yaml in your project’s root repository.

  2. Copy the contents from this file into .github/pages.yaml.

  3. (Optional) If your repository default branch is not master, edit the configuration file to use the default branch name instead.

  4. Commit and push the changes to GitHub (default branch).

  5. Wait a couple of minutes; it might take a while until GitHub builds the site. If everything goes well, you will see the docs published under https://scylladb.github.io/<repository-slug>.

Setting up a custom domain

Note

You need access to the domain DNS configuration.

Follow the next steps to set up a custom domain:

  1. In the domain’s DNS configuration, create a new CNAME record that points <custom-sudomain>.scylladb.com to scylladb.github.io.

  2. Change html_baseurl setting in conf.py for the desired sub-domain name. For instance, we will use sphinx-theme.scylladb.com.

  3. Once the DNS changes propagate (<24 h), the docs will be accessible from the custom domain name.

Disabling GitHub Pages

To disable the docs deployment temporarily, see Unpublishing a GitHub Pages Site.