Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes: JSON Example, SSL Connection Examples, RTD version #1887

Merged
merged 2 commits into from Jan 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
180 changes: 0 additions & 180 deletions docs/examples/.ipynb_checkpoints/connection_example-checkpoint.ipynb

This file was deleted.

2 changes: 2 additions & 0 deletions docs/redismodules.rst
Expand Up @@ -109,6 +109,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