Skip to content

Clarify that the development installation instructions are for Linux #8494

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

Merged
merged 2 commits into from
Sep 15, 2021
Merged

Clarify that the development installation instructions are for Linux #8494

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1115fd
Clarify that the development installation instructions are for Linux
astrojuanlu Sep 15, 2021
53bd4d1
Do not exclude non-Linux UNIX-like systems like macOS
astrojuanlu Sep 15, 2021
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
4 changes: 4 additions & 0 deletions docs/development/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ These are development setup and :ref:`standards <development/install:Core team s
developing Read the Docs and related services. If you are a contributor to Read the Docs,
it might a be a good idea to follow these guidelines as well.

To follow these instructions you will need a Linux-like operating system,
including `Windows Subsystem for Linux (WSL) <https://docs.microsoft.com/en-us/windows/wsl/>`_.
Other systems are not supported.

.. note::

We do not recommend to follow this guide to deploy an instance of Read the Docs for production usage.
Expand Down