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

Mention using ssh URLs when using private submodules #7046

Merged
merged 1 commit into from
May 11, 2020
Merged

Mention using ssh URLs when using private submodules #7046

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 0 deletions docs/guides/private-submodules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ In order to give Read the Docs access to clone your submodules you'll need to ad
You can manage which submodules Read the Docs should clone using a configuration file.
See :ref:`config-file/v2:submodules`.

.. note::

Make sure you are using ``SSH`` URLs for your submodules
(``git@github.com:readthedocs/readthedocs.org.git`` for example)
in your ``.gitmodules`` file, not ``http`` URLs.

.. contents:: Table of contents
:local:
Expand Down