Spaces:
Runtime error
Runtime error
update readme and app markdown
Browse files
README.md
CHANGED
@@ -25,8 +25,9 @@ RAGTheDocs is an open-source library that allows you to **one-click deploy** ret
|
|
25 |
|
26 |
3) Set your environment variables:
|
27 |
* `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
|
28 |
-
* `READTHEDOCS_URL` (required): The url of the website you are interested in scraping
|
29 |
-
|
|
|
30 |
|
31 |
## Features π
|
32 |
|
|
|
25 |
|
26 |
3) Set your environment variables:
|
27 |
* `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
|
28 |
+
* `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
|
29 |
+
sphinx/readthedocs). e.g. `https://orion.readthedocs.io`
|
30 |
+
* `READTHEDOCS_VERSION` (optional): This is important if there exist multiple versions of the docs (e.g. `en/v0.2.7` or `en/latest`). If left empty, it will scrape all available versions (there can be many for open-source projects!).
|
31 |
|
32 |
## Features π
|
33 |
|
app.py
CHANGED
@@ -133,8 +133,8 @@ with demo:
|
|
133 |
|
134 |
* `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
|
135 |
* `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
|
136 |
-
sphinx/readthedocs)
|
137 |
-
* `READTHEDOCS_VERSION` (optional): This is important
|
138 |
|
139 |
Try it out by asking a question below π about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
|
140 |
|
|
|
133 |
|
134 |
* `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
|
135 |
* `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
|
136 |
+
sphinx/readthedocs). e.g. `https://orion.readthedocs.io`
|
137 |
+
* `READTHEDOCS_VERSION` (optional): This is important if there exist multiple versions of the docs (e.g. `en/v0.2.7` or `en/latest`). If left empty, it will scrape all available versions (there can be many for open-source projects!).
|
138 |
|
139 |
Try it out by asking a question below π about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
|
140 |
|