Skip to content

doc: improve the docs #316

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.

Sign up for GitHub

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

Merged
frostming merged 1 commit into from
Jun 10, 2023
Merged

doc: improve the docs #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 8 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ["sphinx.ext.autodoc", "sphinx.ext.todo", "sphinx.ext.viewcode"]
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -86,7 +91,7 @@
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
Expand All @@ -96,7 +101,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "default"
html_theme = "furo"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
12 changes: 10 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ If you give it a try, please let me know of any issues.
.. _pip: http://www.pip-installer.org/


Contents:
Contents
========

.. toctree::
:maxdepth: 2
Expand All @@ -89,8 +90,15 @@ Contents:
etags
custom_heuristics
tips
release_notes

.. toctree::
:hidden:
:caption: Development
:maxdepth: 2

release_notes
GitHub <https://github.com/psf/cachecontrol>
PyPI <https://pypi.org/project/cachecontrol>


Indices and tables
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ The project has been moved to the `PSF <https://github.com/psf>`_ organization.
* Add type annotations.
* Exclude the ``tests`` directory from the wheel.

0.12.14
=======

* Revert the change "switch lockfile to filelock" to fix the compatibility issue.

0.12.13
=======

* Discard the ``strict`` attribute when serializing and deserializing responses.
* Fix the IncompleteRead error thrown by ``urllib3`` 2.0.
* Exclude the tests directory from the wheel.

0.12.11
=======

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.[dev]
2 changes: 2 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ dev = [
"pytest",
"cherrypy",
"sphinx",
"furo",
"sphinx-copybutton",
"black",
"types-redis",
"types-requests",
Expand Down