Skip to content

Commit 2598b33

Browse files
committed
update to configuration doc
1 parent 6a683a5 commit 2598b33

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

docs/configuration.md

+30-8
Original file line numberDiff line numberDiff line change
@@ -104,19 +104,30 @@ API_URL = "https://example.com/api"
104104

105105
## Python settings
106106

107+
The existence of the `python` section indicates a dependency on python for the deployment. All attributes are
108+
optional, so the python section can be as simple as:
109+
110+
```toml
111+
[python]
112+
```
113+
107114
#### package_file
108115

109-
File containing package dependencies. The file must exist and be listed under 'files'. The default is 'requirements.txt'.
116+
File containing package dependencies. This entry is optional and defaults to `requirements.txt`. When provided, the file must exist and be listed within `files`.
110117

111118
#### package_manager
112119

113-
Package manager that will install the dependencies. Supported values are `pip` and `none`. If package-manager is `none`, dependencies will not be installed.
120+
Package manager that will install the dependencies. This entry is optional and defaults to `pip`. Supported values are `pip` and `none`. If package-manager is `none`, dependencies will not be installed.
114121

115122
#### version
116123

117-
Python version. The server must have a matching Python major/minor version in order to run the content.
124+
Python version. The server must have a matching Python major/minor version in order to run the content. This entry is
125+
optional and defaults to the version of the active Python interpreter.
118126

119-
Example:
127+
By not supplying the python version attribute, the requested python version will "float" to the active version of Python being
128+
used at the time of deployment. This may or may not be desired. If you need to "lock" it down, then provide the desired target value
129+
130+
#### Example: (with all attributes provided)
120131

121132
```toml
122133
[python]
@@ -127,19 +138,30 @@ package_manager = "pip"
127138

128139
## R settings
129140

141+
The existence of the `r` section indicates a dependency on R for the deployment. All attributes are
142+
optional, so the r section can be as simple as:
143+
144+
```toml
145+
[r]
146+
```
147+
130148
#### package_file
131149

132-
File containing package dependencies. This is usually `renv.lock`. The file must exist and be listed under 'files'.
150+
File containing package dependencies. This entry is optional and defaults to the package file configured within the active R interpreter's `renv` installation (this is usually `renv.lock`). When provided, the file must exist and be listed within `files`.
133151

134152
#### package_manager
135153

136-
Package manager that will install the dependencies. Supported values are `renv` and `none`. If package-manager is `none`, dependencies will be assumed to be pre-installed on the server.
154+
Package manager that will install the dependencies. This entry is optional and defaults to `renv`. Supported values are `renv` and `none`. If package-manager is `none`, dependencies will not be installed.
137155

138156
#### version
139157

140-
R version. The server will use the nearest R version to run the content.
158+
R version. The server will use the nearest R version to run the content. This entry is
159+
optional and defaults to the version of the active R interpreter.
141160

142-
Example:
161+
By not supplying the r version attribute, the requested r version will "float" to the active version of R being
162+
used at the time of deployment. This may or may not be desired. If you need to "lock" it down, then provide the desired target value
163+
164+
#### Example: (with all attributes provided)
143165

144166
```toml
145167
[r]

0 commit comments

Comments
 (0)