Skip to content

Commit 3838493

Browse files
authored
Re-enabling read-the-docs (#1707)
1 parent 46f9351 commit 3838493

File tree

6 files changed

+41
-199
lines changed

6 files changed

+41
-199
lines changed

.readthedocs.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
python:
4+
install:
5+
- requirements: ./docs/requirements.txt
6+
7+
build:
8+
os: ubuntu-20.04
9+
tools:
10+
python: "3.9"
11+
12+
sphinx:
13+
configuration: docs/conf.py

docs/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@
4646

4747
# General information about the project.
4848
project = "redis-py"
49-
copyright = "2016, Andy McCurdy"
49+
copyright = "2021, Redis Inc."
5050

5151
# The version info for the project you're documenting, acts as replacement for
5252
# |version| and |release|, also used in various other places throughout the
5353
# built documents.
5454
#
5555
# The short X.Y version.
56-
version = "2.10.5"
56+
version = "4.0.9"
5757
# The full version, including alpha/beta/rc tags.
58-
release = "2.10.5"
58+
release = "4.0.0"
5959

6060
# The language for content autogenerated by Sphinx. Refer to documentation
6161
# for a list of supported languages.
@@ -191,7 +191,7 @@
191191
("index",
192192
"redis-py.tex",
193193
"redis-py Documentation",
194-
"Andy McCurdy",
194+
"Redis Inc",
195195
"manual"),
196196
]
197197

@@ -240,7 +240,7 @@
240240
"index",
241241
"redis-py",
242242
"redis-py Documentation",
243-
"Andy McCurdy",
243+
"Redis Inc",
244244
"redis-py",
245245
"One line description of project.",
246246
"Miscellaneous",
@@ -257,6 +257,6 @@
257257
# texinfo_show_urls = 'footnote'
258258

259259
epub_title = "redis-py"
260-
epub_author = "Andy McCurdy"
261-
epub_publisher = "Andy McCurdy"
262-
epub_copyright = "2011, Andy McCurdy"
260+
epub_author = "Redis Inc"
261+
epub_publisher = "Redis Inc"
262+
epub_copyright = "2021, Redis Inc"

docs/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,21 @@ Contents:
2222
.. automodule:: redis
2323
:members:
2424

25+
.. automodule:: redis.backoff
26+
:members:
27+
28+
.. automodule:: redis.connection
29+
:members:
30+
31+
.. automodule:: redis.commands
32+
:members:
33+
34+
.. automodule:: redis.exceptions
35+
:members:
36+
37+
.. automodule:: redis.lock
38+
:members:
39+
2540
.. automodule:: redis.sentinel
2641
:members:
42+

docs/make.bat

Lines changed: 0 additions & 190 deletions
This file was deleted.

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx<2
2+
docutils<0.18

tox.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ exclude =
127127
.tox,
128128
.venv*,
129129
build,
130+
docs/*,
130131
dist,
131132
docker,
132133
venv*,
133-
whitelist.py
134+
whitelist.py

0 commit comments

Comments
 (0)