Troubleshooting¶

How to use the toolchain in Windows¶

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

2. Run make commands from a Unix-based terminal such as Git Bash.

How to preview latest local changes with multiversion¶

By default, the command builds the documentation that is available on GitHub (remote repository).

To build multiversion docs for the local branches:

1. In conf.py, set smv_remote_whitelist to None:

smv_remote_whitelist = None

2. Follow Syncing a Fork for every branch not updated in your fork.

3. Run make multiversionpreview again.

How to preview locally the documentation published in production¶

1. Follow these steps to configure a remote that points to the upstream repository in Git.

2. Download the latest tags and branches from upstream:

git fetch --all

3. Edit the setting smv_remote_whitelist in the file conf.py to build the docs from upstream as follows:

smv_remote_whitelist = r"^upstream$"

4. Run the command make multiversionpreview again.

How to fix the error “No matching refs found!”¶

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.