summaryrefslogtreecommitdiff
path: root/docs/index.md
blob: 8a3e9c3f12e080ceb3dbb3614a8e43fefce41f68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<!--
Pre-release warning to reduce confusion on what '/latest' means;
TODO: add script to make this conditional
-->
<!--
  :::{dropdown} Note
  :animate: fade-in-slide-down
  :color: primary
  :icon: alert

  You are viewing the pre-release documentation, which may describe features that are still in development.
  Documentation for the latest stable release can be found at [requests-cache.readthedocs.io](https://requests-cache.readthedocs.io)
  ```
-->

(index-page)=
# Requests-Cache
<!-- Include Readme contents, except for the links to readthedocs, which would be redundant here -->
```{include} ../README.md
:start-line: 2
:end-before: <!-- RTD-IGNORE -->
```
```{include} ../README.md
:start-after: <!-- END-RTD-IGNORE -->
:end-before: <!-- RTD-IGNORE -->
:relative-docs: docs/
:relative-images:
```

# Contents
```{toctree}
:maxdepth: 2

user_guide
examples
reference
project_info
````