From ee1ae4cfc53256bc1e4702cda878a3744e044355 Mon Sep 17 00:00:00 2001 From: Ian Kenney Date: Mon, 8 May 2023 17:09:48 +0000 Subject: [PATCH] Added missing URLs for external hyperlinks --- docs/source/usage.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 3f074bfb..36f767c3 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -5,7 +5,7 @@ Getting up and running requires a short process. You will need the following: * Python 3.8+ - * The `cookiecutter`_ tool installed + * The cookiecutter_ tool installed * A GitHub account @@ -35,7 +35,7 @@ Please see :ref:`options-label` for more details. The generated repository should be an initialised git repository. We now need to connect it to GitHub: -#. `Create a new repository on GitHub`_ . +#. `Create a new repository on GitHub `_ . Do not initialize the repo with a README, license, or any other files. #. Push the local repository to GitHub. GitHub should provide instructions for doing so, but in short: @@ -58,6 +58,7 @@ To link ReadTheDocs, ensure that you have a `ReadTheDocs`_ account; you should be able to use your GitHub account. To link the project, click the ``Import a Project`` button on the dashboard. + We strongly recommend turning on building documentation for your pull requests to check and preview your docs. To do so: @@ -123,3 +124,7 @@ To keep things clean and simple, we advise a few tips: as well as collaborate with other people. See `GitHub's documentation on PRs `_ for more information. + + +.. _ReadTheDocs: https://readthedocs.org/ +.. _cookiecutter: https://cookiecutter.readthedocs.io/en/stable/