Skip to content

Commit 6517a12

Browse files
committed
How to tell that html_root_url is correct
1 parent b36cc0d commit 6517a12

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/documentation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ updated together, like:
238238
version = "0.3.8" # remember to update html_root_url
239239
```
240240

241+
For documentation hosted outside of docs.rs, the value for `html_root_url` is
242+
correct if appending the crate name + index.html takes you to the documentation
243+
of the crate's root module. For example if the documentation of the root module
244+
is located at `"https://api.rocket.rs/rocket/index.html"` then the
245+
`html_root_url` would be `"https://api.rocket.rs"`.
246+
241247

242248
<a id="c-relnotes"></a>
243249
## Release notes document all significant changes (C-RELNOTES)

0 commit comments

Comments
 (0)