Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ py_library(
visibility = ["//visibility:public"],
)

# In order to update the requirements, change the `requirements.txt` file and run:
# `bazel run //src:requirements`.
# This will update the `requirements_lock.txt` file.
# In order to update the requirements, change the `requirements.in` file and run:
# `bazel run //src:requirements.update`.
# This will update the `requirements.txt` file.
# To upgrade all dependencies to their latest versions, run:
# `bazel run //src:requirements -- --upgrade`.
# `bazel run //src:requirements.update -- --upgrade`.
compile_pip_requirements(
name = "requirements",
srcs = [
Expand Down
17 changes: 17 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,23 @@ Find everything related to testing and how to add your on test suite [here](/too

> If you want to develop your own sphinx extension, check out the [extensions guide](/src/extensions/README.md)

## Updating dependencies

The file [requirements.in](./requirements.in) is a [PIP requirements file](https://pip.pypa.io/en/stable/reference/requirements-file-format/) that describe first level dependencies.

The file [requirements.txt](./requirements.txt) is a [pip-compile lock file](https://pip-tools.readthedocs.io/en/latest/cli/pip-compile/) that holds
the pinned dependency tree calculated from [requirements.in](./requirements.in).

To update dependencies (e.g. after adding a dependency), run:
```
bazel run //src:requirements.update
```

To update the full dependency tree, run
```
bazel run //src:requirements.update -- --upgrade
```

## Best Practices

1. **Documentation**
Expand Down
Loading