Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.93 KB

versioning-schemes.rst

File metadata and controls

66 lines (43 loc) · 1.93 KB

URL versioning schemes

The URL 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:

.. seealso::

   :doc:`/guides/setup/versioning-schemes`
     How to configure your project to use a specific versioning scheme.

   :doc:`/versions`
     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 :abbr:`SaaS (Software as a Service)` 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.