summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/conf.py14
-rw-r--r--docs/examples/ssl_connection_examples.ipynb (renamed from docs/examples/ssl_connecton_examples.ipynb)0
-rw-r--r--docs/redismodules.rst2
3 files changed, 12 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 0f11442..b99e46c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -35,6 +35,12 @@ extensions = [
"sphinx.ext.autosectionlabel",
]
+# AutosectionLabel settings.
+# Uses a <page>:<label> schema which doesn't work for duplicate sub-section
+# labels, so set max depth.
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 2
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
@@ -58,10 +64,10 @@ copyright = "2021, Redis Inc"
# The short X.Y version.
import redis
-version = ".".join(redis.__version__.split(".")[0:2])
-
-# The full version, including alpha/beta/rc tags.
-release = redis.__version__
+version = ".".join(redis.__version__.split(".")[0:3])
+release = version
+if version == "99.99.99":
+ release = "dev"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/examples/ssl_connecton_examples.ipynb b/docs/examples/ssl_connection_examples.ipynb
index 386e4af..386e4af 100644
--- a/docs/examples/ssl_connecton_examples.ipynb
+++ b/docs/examples/ssl_connection_examples.ipynb
diff --git a/docs/redismodules.rst b/docs/redismodules.rst
index 07e756d..e4d36b1 100644
--- a/docs/redismodules.rst
+++ b/docs/redismodules.rst
@@ -110,6 +110,8 @@ These are the commands for interacting with the `RediSearch module <https://redi
.. code-block:: python
import redis
+ from redis.commands.search.field import TextField
+
r = redis.Redis()
r.ft().create_index(TextField("play", weight=5.0), TextField("ball"))
print(r.ft().info())