doc: improve the docs (#316)

Author: frostming

docs/conf.py

@@ -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"]
@@ -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 = []
@@ -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

docs/index.rst

@@ -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
@@ -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

docs/release_notes.rst

@@ -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
 =======
 

docs/requirements.txt

@@ -0,0 +1 @@
+.[dev]

pyproject.toml

@@ -56,6 +56,8 @@ dev = [
     "pytest",
     "cherrypy",
     "sphinx",
+    "furo",
+    "sphinx-copybutton",
     "black",
     "types-redis",
     "types-requests",