-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Proxito: support single language project (#10766)
The important changes are in the resolver and unresolver. - A new option was added to the versioning scheme field. - There are some extra validations in place, so users can't create translations if their project doesn't support them. - The versioning scheme field is disabled on translations, since it doesn't any effect there. - All usages of single_version were replaced with versioning scheme, except where it's still required for backwards compatibility (API, sphinx html_context). - Some function/variables were renamed to use the new naming. - Docs were added, not sure if I'm following diataxis right... - single-version.rst was moved into `versioning-schemes.rst` and `guides/setup/versioning-schemes.rst`. A redirect is needed. Some changes on templates need to be ported to ext-theme. Closes #10307
- Loading branch information
Showing
27 changed files
with
529 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
How to change the versioning scheme of your project | ||
=================================================== | ||
|
||
In this guide, we show you how to change the versioning scheme of your project on Read the Docs. | ||
|
||
Changing the versioning scheme of your project will affect the URLs of your documentation, | ||
any existing links to your documentation will break. | ||
If you want to keep the old URLs working, you can create :doc:`redirects </user-defined-redirects>`. | ||
|
||
.. seealso:: | ||
|
||
:doc:`/versioning-schemes` | ||
Reference of all the versioning schemes supported by Read the Docs. | ||
|
||
:doc:`/versions` | ||
General explanation of how versioning works on Read the Docs. | ||
|
||
Changing the versioning scheme | ||
------------------------------ | ||
|
||
#. Go the :guilabel:`Admin` tab of your project. | ||
#. Click on :guilabel:`Advanced Settings`. | ||
#. Select the new versioning scheme in the :guilabel:`Versioning scheme` dropdown. | ||
#. Click on :guilabel:`Save`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
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: | ||
|
||
- `Multiple versions with translations`_. | ||
- `Multiple versions without translations`_. | ||
- `Single version without translations`_. | ||
|
||
.. 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.