Skip to content

Commit 7faaf4e

Browse files
Repackage documentation and apply poetry updates (#146)
Improves VL documentation with new Redis logos, poetry scripting, poetry docs dependencies, and also adds new reranking user guide.
1 parent 4cd53d0 commit 7faaf4e

22 files changed

+1240
-327
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Then install the required libraries:
3838
poetry install --all-extras
3939
```
4040

41-
4241
### Linting and Tests
4342

4443
Check formatting, linting, and typing:
@@ -58,7 +57,7 @@ To run Testcontainers-based tests you need a local Docker installation such as:
5857

5958
#### Running the Tests
6059

61-
Tests (with vectorizers):
60+
Tests w/ vectorizers:
6261
```bash
6362
poetry run test-cov
6463
```
@@ -73,6 +72,19 @@ Tests w/out rerankers:
7372
SKIP_RERANKERS=true poetry run test-cov
7473
```
7574

75+
### Documentation
76+
Docs are served from the `docs/` directory.
77+
78+
Build the docs. Generates the `_build/html` contents:
79+
```bash
80+
poetry run build-docs
81+
```
82+
83+
Serve the documentation with a local webserver:
84+
```bash
85+
poetry run serve-docs
86+
```
87+
7688
### Getting Redis
7789

7890
In order for your applications to use RedisVL, you must have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
1.89 KB
Loading
461 Bytes
Loading
801 Bytes
Loading
Lines changed: 66 additions & 0 deletions
Loading
-41.2 KB
Binary file not shown.
-188 KB
Binary file not shown.

docs/_static/apple-touch-icon.png

-38.5 KB
Binary file not shown.

docs/_static/favicon-16x16.png

-817 Bytes
Binary file not shown.

docs/_static/favicon-32x32.png

-2.23 KB
Binary file not shown.

0 commit comments

Comments
 (0)