Skip to content

Commit 9e450e6

Browse files
authored
[doc] symlink the doc dependency lock file (#58520)
and ask people to use that lock file for building docs. Signed-off-by: Lonnie Liu <lonnie@anyscale.com>
1 parent 16c2f5f commit 9e450e6

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ sphinx:
2020
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
2121
python:
2222
install:
23-
- requirements: python/deplocks/docs/docbuild_depset_py3.10.lock
23+
- requirements: doc/requirements-doc.lock.txt

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To build the documentation, make sure you have `ray` installed first.
88
For building the documentation locally install the following dependencies:
99

1010
```bash
11-
pip install -r requirements-doc.txt
11+
pip install -r requirements-doc.lock.txt
1212
```
1313

1414
## Building the documentation

doc/requirements-doc.lock.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../python/deplocks/docs/docbuild_depset_py3.10.lock

doc/source/ray-contribute/docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ conda activate docs
5050
Install the documentation dependencies with the following command:
5151

5252
```shell
53-
pip install -r requirements-doc.txt
53+
pip install -r requirements-doc.lock.txt
5454
```
5555

56-
Don't use `-U` in this step. You don't want to upgrade dependencies because `requirements-doc.txt` pins exact versions you need to build the docs.
56+
Don't use `-U` in this step; `requirements-doc.lock.txt` is a lock file that pins the exact versions of all the required dependencies.
5757

5858
### Build documentation
5959
Before building, clean your environment first by running:

0 commit comments

Comments
 (0)