From bfba9dc68c841b78ca51e6302d3283d33167f773 Mon Sep 17 00:00:00 2001
From: Mike Fiedler <miketheman@gmail.com>
Date: Sat, 23 Dec 2023 18:09:08 +0000
Subject: [PATCH] docs: replace concrete URLs with references

Any development links will now refer back to the generated docs.

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
---
 docs/_templates/sidebarintro.html | 12 ++++++------
 docs/_templates/sidebarlogo.html  | 12 ++++++------
 docs/community/faq.rst            |  2 +-
 docs/user/quickstart.rst          |  2 ++
 4 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 2b595b54..607bf92c 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -16,15 +16,15 @@
 
 <h3>Useful Links</h3>
 <ul>
-  <li><a href="https://requests.readthedocs.io/en/latest/user/quickstart/">Quickstart</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/user/advanced/">Advanced Usage</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/api/">API Reference</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/community/updates/#release-history">Release History</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/dev/contributing/">Contributors Guide</a></li>
+  <li><a href="{{ pathto('user/quickstart') }}">Quickstart</a></li>
+  <li><a href="{{ pathto('user/advanced') }}">Advanced Usage</a></li>
+  <li><a href="{{ pathto('api') }}">API Reference</a></li>
+  <li><a href="{{ pathto('community/updates') + '#release-history' }}">Release History</a></li>
+  <li><a href="{{ pathto('dev/contributing') }}">Contributors Guide</a></li>
 
   <p></p>
 
-  <li><a href="https://requests.readthedocs.io/en/latest/community/recommended/">Recommended Packages and Extensions</a></li>
+  <li><a href="{{ pathto('community/recommended') }}">Recommended Packages and Extensions</a></li>
 
   <p></p>
 
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
index a3454b7c..71eb82e7 100644
--- a/docs/_templates/sidebarlogo.html
+++ b/docs/_templates/sidebarlogo.html
@@ -11,15 +11,15 @@
 
 <h3>Useful Links</h3>
 <ul>
-  <li><a href="https://requests.readthedocs.io/en/latest/user/quickstart/">Quickstart</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/user/advanced/">Advanced Usage</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/api/">API Reference</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/community/updates/#release-history">Release History</a></li>
-  <li><a href="https://requests.readthedocs.io/en/latest/dev/contributing/">Contributors Guide</a></li>
+  <li><a href="{{ pathto('user/quickstart') }}">Quickstart</a></li>
+  <li><a href="{{ pathto('user/advanced') }}">Advanced Usage</a></li>
+  <li><a href="{{ pathto('api') }}">API Reference</a></li>
+  <li><a href="{{ pathto('community/updates') + '#release-history' }}">Release History</a></li>
+  <li><a href="{{ pathto('dev/contributing') }}">Contributors Guide</a></li>
 
   <p></p>
 
-  <li><a href="https://requests.readthedocs.io/en/latest/community/recommended/">Recommended Packages and Extensions</a></li>
+  <li><a href="{{ pathto('community/recommended') }}">Recommended Packages and Extensions</a></li>
 
   <p></p>
 
diff --git a/docs/community/faq.rst b/docs/community/faq.rst
index 9d900be2..33fb7e84 100644
--- a/docs/community/faq.rst
+++ b/docs/community/faq.rst
@@ -22,7 +22,7 @@ Custom User-Agents?
 -------------------
 
 Requests allows you to easily override User-Agent strings, along with
-any other HTTP Header. See `documentation about headers <https://requests.readthedocs.io/en/latest/user/quickstart/#custom-headers>`_.
+any other HTTP Header. See :ref:`documentation about headers <custom-headers>`.
 
 
 
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
index 464e4f5f..bbf3745e 100644
--- a/docs/user/quickstart.rst
+++ b/docs/user/quickstart.rst
@@ -201,6 +201,8 @@ may better fit your use cases.
    were returned, use ``Response.raw``.
 
 
+.. _custom-headers:
+
 Custom Headers
 --------------