summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-06-17 16:12:24 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-06-17 16:30:18 -0500
commit795c785eae7dbd04419bec5a0d2aec278570a948 (patch)
treec5c444f139ab0097b242696c7695cf1a2eb1e675 /docs
parentbe9ab4157ff58f6b547e594cb427f3a818f32f51 (diff)
downloadrequests-cache-795c785eae7dbd04419bec5a0d2aec278570a948.tar.gz
Update to FontAwesome 6
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py3
-rw-r--r--docs/examples.md2
-rw-r--r--docs/project_info/code_of_conduct.md2
-rw-r--r--docs/project_info/contributing.md2
-rw-r--r--docs/project_info/contributors.md2
-rw-r--r--docs/project_info/history.md2
-rw-r--r--docs/project_info/related_projects.md2
-rw-r--r--docs/user_guide/advanced_requests.md2
-rw-r--r--docs/user_guide/backends.md2
-rw-r--r--docs/user_guide/compatibility.md2
-rw-r--r--docs/user_guide/expiration.md2
-rw-r--r--docs/user_guide/files.md2
-rw-r--r--docs/user_guide/filtering.md2
-rw-r--r--docs/user_guide/general.md2
-rw-r--r--docs/user_guide/headers.md2
-rw-r--r--docs/user_guide/inspection.md2
-rw-r--r--docs/user_guide/installation.md2
-rw-r--r--docs/user_guide/matching.md2
-rw-r--r--docs/user_guide/security.md2
-rw-r--r--docs/user_guide/serializers.md2
-rw-r--r--docs/user_guide/troubleshooting.md2
21 files changed, 21 insertions, 22 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 8634e76..5162e87 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -123,8 +123,7 @@ html_js_files = ['collapsible_container.js']
html_css_files = [
'collapsible_container.css',
'table.css',
- 'https://use.fontawesome.com/releases/v5.15.3/css/all.css',
- 'https://use.fontawesome.com/releases/v5.15.3/css/v4-shims.css',
+ 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css',
]
html_show_copyright = False
html_show_sphinx = False
diff --git a/docs/examples.md b/docs/examples.md
index d1ffba5..e1c3c4d 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -1,5 +1,5 @@
(examples)=
-# {fa}`laptop-code,style=fas` Examples
+# {fas}`laptop-code` Examples
This section contains some complete examples that demonstrate the main features of requests-cache.
## Articles
diff --git a/docs/project_info/code_of_conduct.md b/docs/project_info/code_of_conduct.md
index 9977692..4d6d542 100644
--- a/docs/project_info/code_of_conduct.md
+++ b/docs/project_info/code_of_conduct.md
@@ -1,4 +1,4 @@
-# {fa}`handshake` Code of Conduct
+# {fas}`handshake` Code of Conduct
This Code of Conduct is adapted from
[Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
diff --git a/docs/project_info/contributing.md b/docs/project_info/contributing.md
index 5d40716..aeb997e 100644
--- a/docs/project_info/contributing.md
+++ b/docs/project_info/contributing.md
@@ -1,5 +1,5 @@
(contributing)=
-# {fa}`lightbulb` Contributing
+# {fas}`lightbulb` Contributing
```{include} ../../CONTRIBUTING.md
:start-line: 1
```
diff --git a/docs/project_info/contributors.md b/docs/project_info/contributors.md
index 5c3aaa1..33dde28 100644
--- a/docs/project_info/contributors.md
+++ b/docs/project_info/contributors.md
@@ -1,4 +1,4 @@
-# {fa}`users` Contributors
+# {fas}`users` Contributors
```{include} ../../CONTRIBUTORS.md
:start-line: 1
```
diff --git a/docs/project_info/history.md b/docs/project_info/history.md
index 3bb2b72..f2c0601 100644
--- a/docs/project_info/history.md
+++ b/docs/project_info/history.md
@@ -1,5 +1,5 @@
(changelog)=
-# {fa}`history` History
+# {fas}`history` History
```{include} ../../HISTORY.md
:start-line: 1
```
diff --git a/docs/project_info/related_projects.md b/docs/project_info/related_projects.md
index dd553cc..3a01d19 100644
--- a/docs/project_info/related_projects.md
+++ b/docs/project_info/related_projects.md
@@ -1,5 +1,5 @@
(related-projects)=
-# {fa}`external-link-alt,style=fas` Related Projects
+# {fas}`external-link-alt` Related Projects
If requests-cache isn't quite what you need, you can help make it better! See the
{ref}`Contributing Guide <contributing>` for details.
diff --git a/docs/user_guide/advanced_requests.md b/docs/user_guide/advanced_requests.md
index c6ec9c7..ac9e204 100644
--- a/docs/user_guide/advanced_requests.md
+++ b/docs/user_guide/advanced_requests.md
@@ -1,4 +1,4 @@
-# {fa}`info-circle` Advanced Requests
+# {fas}`info-circle` Advanced Requests
Following are some tips on using requests-cache with some of the more
[advanced features](https://docs.python-requests.org/en/latest/user/advanced/) of the requests
library.
diff --git a/docs/user_guide/backends.md b/docs/user_guide/backends.md
index 76a6c50..7f85fa7 100644
--- a/docs/user_guide/backends.md
+++ b/docs/user_guide/backends.md
@@ -1,5 +1,5 @@
(backends)=
-# {fa}`database` Backends
+# {fas}`database` Backends
This page contains general information about the cache backends supported by requests-cache.
The default backend is SQLite, since it requires no extra dependencies or configuration, and has
diff --git a/docs/user_guide/compatibility.md b/docs/user_guide/compatibility.md
index 510530b..12f2203 100644
--- a/docs/user_guide/compatibility.md
+++ b/docs/user_guide/compatibility.md
@@ -1,5 +1,5 @@
(compatibility)=
-# {fa}`puzzle-piece` Compatibility with other libraries
+# {fas}`puzzle-piece` Compatibility with other libraries
This library works by patching and/or extending {py:class}`requests.Session`. Many other libraries
out there do the same thing, making it potentially difficult to combine them.
diff --git a/docs/user_guide/expiration.md b/docs/user_guide/expiration.md
index 7b15386..9d0ec9c 100644
--- a/docs/user_guide/expiration.md
+++ b/docs/user_guide/expiration.md
@@ -1,5 +1,5 @@
(expiration)=
-# {fa}`clock` Expiration
+# {fas}`clock` Expiration
By default, cached responses will be stored indefinitely. There are a number of options for
specifying how long to store responses, either with a single expiration value, glob patterns,
or {ref}`cache headers <headers>`.
diff --git a/docs/user_guide/files.md b/docs/user_guide/files.md
index 2f89fb8..c47783e 100644
--- a/docs/user_guide/files.md
+++ b/docs/user_guide/files.md
@@ -1,5 +1,5 @@
(files)=
-# {fa}`folder-open` Cache Files
+# {fas}`folder-open` Cache Files
```{note}
This section only applies to the {py:mod}`SQLite <requests_cache.backends.sqlite>` and
{py:mod}`Filesystem <requests_cache.backends.filesystem>` backends.
diff --git a/docs/user_guide/filtering.md b/docs/user_guide/filtering.md
index 86a5afe..885b991 100644
--- a/docs/user_guide/filtering.md
+++ b/docs/user_guide/filtering.md
@@ -1,5 +1,5 @@
(filtering)=
-# {fa}`filter` Cache Filtering
+# {fas}`filter` Cache Filtering
In many cases you will want to choose what you want to cache instead of just caching everything. By
default, all **read-only** (`GET` and `HEAD`) **requests with a 200 response code** are cached. A
few options are available to modify this behavior.
diff --git a/docs/user_guide/general.md b/docs/user_guide/general.md
index 20b6b2a..3c8a20c 100644
--- a/docs/user_guide/general.md
+++ b/docs/user_guide/general.md
@@ -1,5 +1,5 @@
(general)=
-# {fa}`play-circle` General Usage
+# {fas}`play-circle` General Usage
There are two main ways of using requests-cache:
- **Sessions:** (recommended) Use {py:class}`.CachedSession` to send your requests
- **Patching:** Globally patch `requests` using {py:func}`.install_cache()`
diff --git a/docs/user_guide/headers.md b/docs/user_guide/headers.md
index 5fd77b0..792b1d2 100644
--- a/docs/user_guide/headers.md
+++ b/docs/user_guide/headers.md
@@ -1,5 +1,5 @@
(headers)=
-# {fa}`file-code` Cache Headers
+# {fas}`file-code` Cache Headers
Requests-cache supports most common HTTP caching headers, including
[ETags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag),
[Cache-Control](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control),
diff --git a/docs/user_guide/inspection.md b/docs/user_guide/inspection.md
index 73f7c29..cc7bb39 100644
--- a/docs/user_guide/inspection.md
+++ b/docs/user_guide/inspection.md
@@ -1,6 +1,6 @@
<!-- TODO: This could use some more details and examples -->
(inspection)=
-# {fa}`search` Cache Inspection
+# {fas}`search` Cache Inspection
Here are some ways to get additional information out of the cache session, backend, and responses:
## Response Details
diff --git a/docs/user_guide/installation.md b/docs/user_guide/installation.md
index a5d4176..65ab45d 100644
--- a/docs/user_guide/installation.md
+++ b/docs/user_guide/installation.md
@@ -1,4 +1,4 @@
-# {fa}`download` Installation
+# {fas}`download` Installation
Installation instructions:
:::{tab} Pip
diff --git a/docs/user_guide/matching.md b/docs/user_guide/matching.md
index 055ad28..c79e636 100644
--- a/docs/user_guide/matching.md
+++ b/docs/user_guide/matching.md
@@ -1,5 +1,5 @@
(matching)=
-# {fa}`equals,style=fas` Request Matching
+# {fas}`equals` Request Matching
Requests are matched according to the request method, URL, parameters and body. All of these values
are normalized to account for any variations that do not modify response content.
diff --git a/docs/user_guide/security.md b/docs/user_guide/security.md
index adc09a5..68d049d 100644
--- a/docs/user_guide/security.md
+++ b/docs/user_guide/security.md
@@ -1,5 +1,5 @@
(security)=
-# {fa}`lock` Security
+# {fas}`lock` Security
## Pickle Vulnerabilities
:::{warning}
diff --git a/docs/user_guide/serializers.md b/docs/user_guide/serializers.md
index 865aa4b..77980b0 100644
--- a/docs/user_guide/serializers.md
+++ b/docs/user_guide/serializers.md
@@ -1,5 +1,5 @@
(serializers)=
-# {fa}`barcode` Serializers
+# {fas}`barcode` Serializers
![](../_static/file-pickle_32px.png)
![](../_static/file-json_32px.png)
![](../_static/file-yaml_32px.png)
diff --git a/docs/user_guide/troubleshooting.md b/docs/user_guide/troubleshooting.md
index d4e412b..899a282 100644
--- a/docs/user_guide/troubleshooting.md
+++ b/docs/user_guide/troubleshooting.md
@@ -1,5 +1,5 @@
(debug)=
-# {fa}`exclamation-circle` Troubleshooting
+# {fas}`exclamation-circle` Troubleshooting
Here are a few tips for avoiding and debugging some common problems.
## General Tips