| |
@@ -1,225 +0,0 @@
|
| |
- From 9e85aea3e6a01b7ee2630099cd5365f24d101fd6 Mon Sep 17 00:00:00 2001
|
| |
- From: Ali-Akber Saifee <ali@indydevs.org>
|
| |
- Date: Mon, 6 Jun 2022 08:40:17 -0700
|
| |
- Subject: [PATCH] Update documentation dependencies
|
| |
-
|
| |
- - Switch from sphinx_panels -> sphinx_inline_tabs
|
| |
- - Upgrade to sphinx 5
|
| |
- ---
|
| |
- doc/source/api.rst | 4 ++--
|
| |
- doc/source/conf.py | 2 +-
|
| |
- doc/source/installation.rst | 14 +++++++-------
|
| |
- doc/source/quickstart.rst | 6 +++---
|
| |
- doc/source/storage.rst | 8 ++++----
|
| |
- doc/source/theme_config.py | 7 -------
|
| |
- requirements/docs.txt | 6 +++---
|
| |
- 7 files changed, 20 insertions(+), 27 deletions(-)
|
| |
-
|
| |
- diff --git a/doc/source/api.rst b/doc/source/api.rst
|
| |
- index 120fb3f4..a6c6609d 100644
|
| |
- --- a/doc/source/api.rst
|
| |
- +++ b/doc/source/api.rst
|
| |
- @@ -17,7 +17,7 @@ Strategies
|
| |
- ==========
|
| |
-
|
| |
-
|
| |
- -.. tabbed:: Default
|
| |
- +.. tab:: Default
|
| |
-
|
| |
- The available built in rate limiting strategies which expect
|
| |
- a single parameter: a subclass of :class:`~limits.storage.Storage`.
|
| |
- @@ -34,7 +34,7 @@ Strategies
|
| |
-
|
| |
- .. autoclass:: RateLimiter
|
| |
-
|
| |
- -.. tabbed:: Async
|
| |
- +.. tab:: Async
|
| |
-
|
| |
-
|
| |
- These variants should be used in for asyncio support. These strategies
|
| |
- diff --git a/doc/source/conf.py b/doc/source/conf.py
|
| |
- index b2af84a3..e05fc3c8 100644
|
| |
- --- a/doc/source/conf.py
|
| |
- +++ b/doc/source/conf.py
|
| |
- @@ -50,7 +50,7 @@
|
| |
- "sphinxext.opengraph",
|
| |
- "sphinxcontrib.programoutput",
|
| |
- "sphinx_copybutton",
|
| |
- - "sphinx_panels",
|
| |
- + "sphinx_inline_tabs",
|
| |
- "sphinx_paramlinks",
|
| |
- ]
|
| |
-
|
| |
- diff --git a/doc/source/installation.rst b/doc/source/installation.rst
|
| |
- index 308b462f..9c26cdeb 100644
|
| |
- --- a/doc/source/installation.rst
|
| |
- +++ b/doc/source/installation.rst
|
| |
- @@ -8,7 +8,7 @@ Install the package with pip:
|
| |
-
|
| |
- $ pip install limits
|
| |
-
|
| |
- -.. tabbed:: Redis
|
| |
- +.. tab:: Redis
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -18,7 +18,7 @@ Install the package with pip:
|
| |
-
|
| |
- .. literalinclude:: ../../requirements/storage/redis.txt
|
| |
-
|
| |
- -.. tabbed:: RedisCluster
|
| |
- +.. tab:: RedisCluster
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -28,7 +28,7 @@ Install the package with pip:
|
| |
-
|
| |
- .. literalinclude:: ../../requirements/storage/rediscluster.txt
|
| |
-
|
| |
- -.. tabbed:: Memcached
|
| |
- +.. tab:: Memcached
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -38,7 +38,7 @@ Install the package with pip:
|
| |
-
|
| |
- .. literalinclude:: ../../requirements/storage/memcached.txt
|
| |
-
|
| |
- -.. tabbed:: MongoDB
|
| |
- +.. tab:: MongoDB
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -59,7 +59,7 @@ If you are using an async code base you can install the storage dependencies
|
| |
- along with the package using the following extras:
|
| |
-
|
| |
-
|
| |
- -.. tabbed:: Redis
|
| |
- +.. tab:: Redis
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -69,7 +69,7 @@ along with the package using the following extras:
|
| |
-
|
| |
- .. literalinclude:: ../../requirements/storage/async-redis.txt
|
| |
-
|
| |
- -.. tabbed:: Memcached
|
| |
- +.. tab:: Memcached
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- @@ -79,7 +79,7 @@ along with the package using the following extras:
|
| |
-
|
| |
- .. literalinclude:: ../../requirements/storage/async-memcached.txt
|
| |
-
|
| |
- -.. tabbed:: MongoDB
|
| |
- +.. tab:: MongoDB
|
| |
-
|
| |
- .. code:: console
|
| |
-
|
| |
- diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
|
| |
- index 599b26b1..6c2de62e 100644
|
| |
- --- a/doc/source/quickstart.rst
|
| |
- +++ b/doc/source/quickstart.rst
|
| |
- @@ -8,14 +8,14 @@ Initialize the strategy & storage
|
| |
- Initialize the storage backend
|
| |
- ------------------------------
|
| |
-
|
| |
- -.. tabbed:: In Memory
|
| |
- +.. tab:: In Memory
|
| |
-
|
| |
- .. code::
|
| |
-
|
| |
- from limits import storage
|
| |
- memory_storage = storage.MemoryStorage()
|
| |
-
|
| |
- -.. tabbed:: Memcached
|
| |
- +.. tab:: Memcached
|
| |
-
|
| |
- .. code::
|
| |
-
|
| |
- @@ -24,7 +24,7 @@ Initialize the storage backend
|
| |
- "memcached://localhost:11211"
|
| |
- )
|
| |
-
|
| |
- -.. tabbed:: Redis
|
| |
- +.. tab:: Redis
|
| |
-
|
| |
- .. code::
|
| |
-
|
| |
- diff --git a/doc/source/storage.rst b/doc/source/storage.rst
|
| |
- index 1e801d00..9fdadb2e 100644
|
| |
- --- a/doc/source/storage.rst
|
| |
- +++ b/doc/source/storage.rst
|
| |
- @@ -23,7 +23,7 @@ dependency libraries and the associated storage versions.
|
| |
- The CI tests against these versions on a nightly basis and you can see
|
| |
- the results in `github <https://github.com/alisaifee/limits/actions/workflows/compatibility.yml>`_.
|
| |
-
|
| |
- -.. tabbed:: Redis
|
| |
- +.. tab:: Redis
|
| |
-
|
| |
- Dependency versions:
|
| |
-
|
| |
- @@ -45,7 +45,7 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
|
| |
-
|
| |
- .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SENTINEL_SERVER_VERSION=[\d\.]+' | cut -d = -f 2"
|
| |
-
|
| |
- -.. tabbed:: Redis Cluster
|
| |
- +.. tab:: Redis Cluster
|
| |
-
|
| |
- Dependency versions:
|
| |
-
|
| |
- @@ -59,7 +59,7 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
|
| |
-
|
| |
- .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_REDIS_SERVER_VERSION=[\d\.]+' | cut -d = -f 2"
|
| |
-
|
| |
- -.. tabbed:: Memcached
|
| |
- +.. tab:: Memcached
|
| |
-
|
| |
- Dependency versions:
|
| |
-
|
| |
- @@ -73,7 +73,7 @@ the results in `github <https://github.com/alisaifee/limits/actions/workflows/co
|
| |
-
|
| |
- .. program-output:: bash -c "cat ../../.github/workflows/compatibility.yml | grep -o -P 'LIMITS_MEMCACHED_SERVER_VERSION=[\d\.]+' | cut -d = -f 2"
|
| |
-
|
| |
- -.. tabbed:: MongoDB
|
| |
- +.. tab:: MongoDB
|
| |
-
|
| |
- Dependency versions:
|
| |
-
|
| |
- diff --git a/doc/source/theme_config.py b/doc/source/theme_config.py
|
| |
- index 951c1850..adf0f674 100644
|
| |
- --- a/doc/source/theme_config.py
|
| |
- +++ b/doc/source/theme_config.py
|
| |
- @@ -45,13 +45,6 @@
|
| |
- "color-highlight-on-target": colors["fg2"],
|
| |
- },
|
| |
- }
|
| |
- -panels_css_variables = {
|
| |
- - "tabs-color-label-active": colors["purple"],
|
| |
- - "tabs-color-label-inactive": colors["purple2"],
|
| |
- - "tabs-color-overline": colors["purple2"],
|
| |
- - "tabs-color-underline": colors["purple2"],
|
| |
- - "tabs-size-label": "1rem",
|
| |
- -}
|
| |
-
|
| |
- highlight_language = "python3"
|
| |
- pygments_style = "gruvbox-light"
|
| |
- diff --git a/requirements/docs.txt b/requirements/docs.txt
|
| |
- index 331f5035..2d5537b6 100644
|
| |
- --- a/requirements/docs.txt
|
| |
- +++ b/requirements/docs.txt
|
| |
- @@ -1,10 +1,10 @@
|
| |
- -r main.txt
|
| |
- -furo==2022.6.4
|
| |
- -Sphinx<5
|
| |
- +furo==2022.6.4.1
|
| |
- +Sphinx>=5
|
| |
- sphinx-copybutton==0.5.0
|
| |
- sphinx-autobuild==2021.3.14
|
| |
- sphinxext-opengraph==0.6.2
|
| |
- -sphinx-panels==0.6.0
|
| |
- +sphinx-inline-tabs==2022.1.2b11
|
| |
- sphinx-paramlinks==0.5.4
|
| |
- sphinxcontrib-programoutput==0.17
|
| |
-
|
| |
Add conditionals to support building for F36 and F35 without
redisandredisclusterextras. (Also, don’t build the-docsubpackage on F35.)Update from 2.6.3 to 2.7.0.
Source diff: https://github.com/alisaifee/limits/compare/2.6.3...2.7.0
Release notes:
This is a compatible update suitable for stable releases. It looks like this is currently a leaf package, so no dependent packages are potentially upper-bounding the version.
Fixes:
https://bugzilla.redhat.com/show_bug.cgi?id=2107863
https://bugzilla.redhat.com/show_bug.cgi?id=2133279 (when branched and built for F36 and F35)