Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: specify sphinx dirhtml builder, use references instead of absolutes #6612

Merged
merged 4 commits into from
Dec 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ build:
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
builder: "dirhtml"

# Optionally build your docs in additional formats such as PDF and ePub
formats:
Expand Down
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,4 @@ Patches and Suggestions
- Alessio Izzo (`@aless10 <https://github.com/aless10>`_)
- Sylvain Marié (`@smarie <https://github.com/smarie>`_)
- Hod Bin Noon (`@hodbn <https://github.com/hodbn>`_)
- Mike Fiedler (`@miketheman <https://github.com/miketheman>`_)
12 changes: 6 additions & 6 deletions docs/_templates/sidebarintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@

<h3>Useful Links</h3>
<ul>
<li><a href="https://requests.readthedocs.io/en/latest/user/quickstart.html">Quickstart</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/user/advanced.html">Advanced Usage</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/api.html">API Reference</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/community/updates.html#release-history">Release History</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/dev/contributing.html">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>

Expand Down
12 changes: 6 additions & 6 deletions docs/_templates/sidebarlogo.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@

<h3>Useful Links</h3>
<ul>
<li><a href="https://requests.readthedocs.io/en/latest/user/quickstart.html">Quickstart</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/user/advanced.html">Advanced Usage</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/api.html">API Reference</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/community/updates.html#release-history">Release History</a></li>
<li><a href="https://requests.readthedocs.io/en/latest/dev/contributing.html">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.html">Recommended Packages and Extensions</a></li>
<li><a href="{{ pathto('community/recommended') }}">Recommended Packages and Extensions</a></li>

<p></p>

Expand Down
2 changes: 1 addition & 1 deletion docs/community/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`.



Expand Down
2 changes: 2 additions & 0 deletions docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,8 @@ may better fit your use cases.
were returned, use ``Response.raw``.


.. _custom-headers:

Custom Headers
--------------

Expand Down
Loading