URLs are an important part of your documentation.Users can infer from the URL if your documentation has or supportsmultiple versions or translations.
Until now, Read the Docs allowed you to configure your project in two ways:
Resulting in URLs like:
/en/latest/index.html
/es/latest/index.html
/en/1.0/index.html
Resulting in URLs like:
/index.html
/api/v3.html
While not all projects have or require translations, many benefit from having multiple versions.This meant that projects without translations but with need for multiple versions,had to opt into supporting translations in order to have multiple versions.
We’re excited to announce that we now support projects with multiple versions without translations.Resulting in URLs like:
/latest/index.html
/1.0/index.html
Now instead of having aSingleversion checkbox in theAdmin page of your project,you’ll see aVersioningscheme dropdown with three options available.
In order to support this new feature, we have made some changes to the API.Specifically, thesingle_version field has been deprecated in favor of theversioning_scheme field.
When updating a project, you should use theversioning_scheme field instead of thesingle_version field.To avoid breaking existing integrations,thesingle_version field will still be returned in the API,but you should use theversioning_scheme field instead.
Sign up for our blog and we'll send you news and updates about Sphinx and Read the Docs on a regular basis.
You have successfully joined our subscriber list.
Read the Docs Blog