Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
To run the toolchain on Windows, you will need to:
1. Edit the POETRY constant in docs/Makefile to point to the PATH where you have installed Poetry.
This is normally under C:\Users\<username>\AppData\Roaming\Python\Scripts\poetry.
POETRY = C:\Users\<username>\AppData\Roaming\Python\Scripts\poetry
Run make commands from a Unix-based terminal such as Git Bash.
By default, the command builds the documentation that is available on GitHub (remote repository).
To build multiversion docs for the local branches:
In conf.py, set smv_remote_whitelist to None:
smv_remote_whitelist = None
Follow Syncing a Fork for every branch not updated in your fork.
Run make multiversionpreview again.
Follow these steps to configure a remote that points to the upstream repository in Git.
Download the latest tags and branches from upstream:
git fetch --all
Edit the setting smv_remote_whitelist in the file conf.py to build the docs from upstream as follows:
smv_remote_whitelist = r"^upstream$"
Run the command make multiversionpreview again.
If the console raises the error “No matching refs found!”, most likely your fork is not updated with the upstream repository.
In this case, you can:
Build multiversion docs for the upstream repository. See Preview documentation published in production (recommended)
Sync the fork with the upstream repository. See Preview latest local changes
Another frequent mistake that raises the error message is to have typos in the configuration file. Make sure that the version names listed in TAGS and BRANCHES settings from conf.py match the repository’s branch and tags names on Git.
Was this page helpful?