Versioning schemes๏
The versioning scheme of your project defines the URL of your documentation, and if your project supports multiple versions or translations.
Read the Docs supports three different versioning schemes:
See also
- How to change the versioning scheme of your project
How to configure your project to use a specific versioning scheme.
- Versioned documentation
General explanation of how versioning works on Read the Docs.
Multiple versions with translations๏
This is the default versioning scheme, itโs the recommend one if your project has multiple versions, and has or plans to support translations.
The URLs of your documentation will look like:
/en/latest//en/1.5//es/latest/install.html/es/1.5/contributing.html
Multiple versions without translations๏
Use this versioning scheme if you want to have multiple versions of your documentation, but donโt want to have translations.
The URLs of your documentation will look like:
/latest//1.5/install.html
Warning
This means you canโt have translations for your documentation.
Single version without translations๏
Having a single version of a documentation project can be considered the better choice in cases where there should only always exist one unambiguous copy of your project. For example:
A research project may wish to only expose readers to their latest list of publications and research data.
A SaaS application might only ever have one version live.
The URLs of your documentation will look like:
//install.html
Warning
This means you canโt have translations or multiple versions for your documentation.