summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-08-20 16:37:53 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-08-20 16:38:34 -0500
commit35622de0fcd2e1d2a3b827c2a4e6ae61c9f4a359 (patch)
treeac5bb8d612e63de5a31944679aa14ce58e9ad902 /docs/index.md
parent307ef03747ea5426fd83153d1d0865a33cb3bb0b (diff)
downloadrequests-cache-35622de0fcd2e1d2a3b827c2a4e6ae61c9f4a359.tar.gz
More info and editing for Readme intro
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/index.md b/docs/index.md
index b49fcc2..ff21039 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,10 +1,13 @@
(index-page)=
-<!-- Include Readme contents, except for the (redundant) link to readthedocs -->
+<!-- Include Readme contents, except for the links to readthedocs, which would be redundant here -->
```{include} ../README.md
-:end-before: Complete project documentation can be found at
+:end-before: <!-- RTD-IGNORE -->
```
```{include} ../README.md
-:start-after: readthedocs.io).
+:start-after: <!-- END-RTD-IGNORE -->
+:end-before: <!-- RTD-IGNORE -->
+:relative-docs: docs/
+:relative-images:
```
# Contents
@@ -13,8 +16,8 @@
user_guide
advanced_usage
-security
examples
+security
reference
contributing
contributors