You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,6 +203,19 @@ The proxy adds two custom headers `x-activestorage-dtype` and `x-activestrorage-
203
203
204
204
---
205
205
206
+
## Documentation
207
+
208
+
The source code is documented using [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html).
209
+
Currently the `s3-active-storage` crate is not uploaded to https://crates.io, so we do not benefit from hosted documentation on https://docs.rs.
210
+
It is however possible to build the documentation locally:
211
+
212
+
```sh
213
+
cargo doc
214
+
```
215
+
216
+
Cargo builds documentation for the `s3-active-storage` crate and all of its dependencies.
217
+
The resulting documentation is available under `target/doc`, and may be viewed in a web browser using file:///path/to/s3-active-storage/target/doc/s3-active-storage/index.html.
218
+
206
219
## Contributing
207
220
208
221
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to S3 active storage.
0 commit comments