Skip to content

Commit

Permalink
Documentation fixes: JSON Example, SSL Connection Examples, RTD versi…
Browse files Browse the repository at this point in the history
…on (redis#1887)
  • Loading branch information
chayim authored and dvora-h committed Jan 25, 2022
1 parent eff0109 commit f230622
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/conf.py
Expand Up @@ -35,6 +35,12 @@
"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"]

Expand All @@ -58,10 +64,10 @@
# 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.
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions docs/redismodules.rst
Expand Up @@ -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())
Expand Down

0 comments on commit f230622

Please sign in to comment.