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.

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

Docs: mention the version warning is for sphinx only #7832

Merged
merged 1 commit into from
Jan 18, 2021
Merged
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion docs/versions.rst
Original file line number Diff line number Diff line change
@@ -143,12 +143,15 @@ This banner has a text with a link redirecting the users to the latest version o
This feature is disabled by default on new projects,
you can enable it in the admin section of your docs (:guilabel:`Admin` > :guilabel:`Advanced Settings`).

.. note::

This feature is available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>`.

Redirects on root URLs
----------------------

When a user hits the root URL for your documentation,
for example ``http://pip.readthedocs.io/``,
for example ``https://pip.readthedocs.io/``,
they will be redirected to the **Default version**.
This defaults to **latest**,
but could also point to your latest released version.