Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post merge fixes #11530

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Post merge fixes #11530

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ff1c88
Fix indent
plaindocs Aug 8, 2024
27b6be8
Tweak link and fix text
plaindocs Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/user/versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can change the states for each version of your documentation in the :guilabe
- You have a work in progress version and don't want to publish its docs just yet.

Hidden verions are listed as ``Disallow: /path/to/version/``
in the default `robots.txt file <https://www.robotstxt.org/>`__ created by Read the Docs.
in the default :doc:`/reference/robots` created by Read the Docs.

**Public** or **Private** (only available on on :doc:`/commercial/index`)
- Public versions are visible to everyone.
Expand All @@ -51,6 +51,7 @@ You can change the states for each version of your documentation in the :guilabe
In addition, if you want other users to view the build page of your public versions,
you'll need to the set the :doc:`privacy level of your project </commercial/privacy-level>` to public.


Tags and branches
-----------------

Expand Down Expand Up @@ -104,13 +105,14 @@ all of which can be reconfigured if necessary:
set the **Default Branch** to the branch you use.

- **tags** are semantic versioning compatible (according to `PEP 440`_) snapshots
of your documentation. The most recent semantic tag maps to the ``stable`` tag.
of your documentation. The most recent semantic tag maps to the ``stable`` version.

Semantic versioning allows "normal" version numbers like ``1.4.2``, as
well as pre-releases like this: ``2.0a1``. The ``stable`` version of your documentation never includes a pre-release.

- If you have documentation changes on a **long-lived branch**,
you can build those too, to see how the new docs will be built.
This is most useful for **release branches**, which are maintained over time for a specific release. An example would be a ``2.1`` branch that is kept up to date with the latest ``2.1.x`` release.
This is most useful for **release branches**, which are maintained over time for a specific release.
An example would be a ``2.1`` branch that is kept up to date with the latest ``2.1.x`` release.

.. _PEP 440: https://www.python.org/dev/peps/pep-0440/
Loading