diff --git a/docs/conf.py b/docs/conf.py index 957a7282..170b7920 100644 --- a/docs/conf.py +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index ca0d0e28..8632c4cc 100644 --- a/docs/index.rst +++ b/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 + PyPI Indices and tables diff --git a/docs/release_notes.rst b/docs/release_notes.rst index be9e9398..749f374e 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -29,6 +29,18 @@ The project has been moved to the `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 ======= diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..e7ab444a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +.[dev] diff --git a/pyproject.toml b/pyproject.toml index ef55536e..619d00e8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,6 +56,8 @@ dev = [ "pytest", "cherrypy", "sphinx", + "furo", + "sphinx-copybutton", "black", "types-redis", "types-requests",