From c8bfa606d71b07a52989d8b1bc104b52c531055b Mon Sep 17 00:00:00 2001 From: Teagan Date: Wed, 14 Feb 2024 17:10:29 -0700 Subject: [PATCH 1/2] update docs to include links to readme --- docs/index.rst | 4 +++- docs/install.rst | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 25f6649..f26f618 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,4 +5,6 @@ CUPiD Documentation :maxdepth: 2 :hidden: - Installation Guide \ No newline at end of file + Installation Guide + +More details can be found in the main repository [README](https://github.com/TeaganKing/CUPiD/blob/main/README.md). diff --git a/docs/install.rst b/docs/install.rst index 1d22182..6ce6f94 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,2 +1,4 @@ Installing CUPiD -================ \ No newline at end of file +================ + +See [Installation instructions](https://github.com/TeaganKing/CUPiD/tree/main?tab=readme-ov-file#installing) From 5290ddb72a55b0c0c7c3ed09722a4b9d6babdaf4 Mon Sep 17 00:00:00 2001 From: Teagan Date: Wed, 14 Feb 2024 17:14:47 -0700 Subject: [PATCH 2/2] fix hyperlinks --- docs/index.rst | 2 +- docs/install.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index f26f618..cb283f1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,4 +7,4 @@ CUPiD Documentation Installation Guide -More details can be found in the main repository [README](https://github.com/TeaganKing/CUPiD/blob/main/README.md). +More details can be found in the main repository `README `_ . diff --git a/docs/install.rst b/docs/install.rst index 6ce6f94..e327772 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,4 +1,4 @@ Installing CUPiD ================ -See [Installation instructions](https://github.com/TeaganKing/CUPiD/tree/main?tab=readme-ov-file#installing) +See `Installation instructions `_ .