-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
516 additions
and
442 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,21 @@ | ||
For a better experience you may consult this documentation at https://redis-limpyd.readthedocs.org/ | ||
For a better experience you may consult this documentation at https://redis-limpyd.readthedocs.io/ where it will be automatically updated when a git tag of a stable release will be pushed. | ||
|
||
It can be hosted locally, though. | ||
|
||
To build it: | ||
|
||
- install sphinx and the "read the doc" theme: | ||
|
||
```bash | ||
pip install -r doc/requirements-doc.txt | ||
``` | ||
|
||
- build the doc | ||
|
||
```bash | ||
python setup.py build_sphinx | ||
``` | ||
|
||
- see it | ||
|
||
go to ``file:///local/path/to/redis-limpyd/doc/_build/html/index.html`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.