Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create RFC for bundling local images in rustdoc output #3

Closed
wants to merge 13 commits into from
Closed

Create RFC for bundling local images in rustdoc output #3

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6ac27fa
Create RFC for bundling local images in rustdoc output
GuillaumeGomez Feb 6, 2023
b6e3a99
Clarifications and add more examples
GuillaumeGomez Feb 6, 2023
864c222
Improve hash computation explanations and add new "Possible extension…
GuillaumeGomez Feb 7, 2023
40b54df
Rename local.resources folder into doc.files
GuillaumeGomez Feb 10, 2023
f9440f1
Remove crate name from the local resources folder path
GuillaumeGomez Feb 10, 2023
4bfda8c
Add information about what happen in case a file isn't found
GuillaumeGomez Feb 13, 2023
088cc0c
Explain better why both absolute and relative paths are necessary
GuillaumeGomez Feb 13, 2023
0d02c9f
Mention published packages
GuillaumeGomez Feb 13, 2023
b0383eb
Improve explanations for absolute paths in docs.rs
GuillaumeGomez Feb 13, 2023
021c95f
* Rewrite motivation section.
GuillaumeGomez Feb 14, 2023
1f287b2
* Mention that `html_favicon_url` and `html_logo_url` will also rely …
GuillaumeGomez Feb 14, 2023
b1203a5
Fix docs.rs appearance and add explanation for cross-crate inlined im…
GuillaumeGomez Feb 17, 2023
c74baba
Add missing backtick around "docs.rs"
GuillaumeGomez Feb 23, 2023
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
6 changes: 5 additions & 1 deletion text/000-rustdoc-bundle-local-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Currently, rustdoc does not allow for the inclusion of local images in the gener

This would make the documentation more engaging and easier to understand while lowering the amount of effort required to achieve a better result.

# Guide-level explanationvide
# Guide-level explanation
[guide-level-explanation]: #guide-level-explanation

This RFC proposes to allow rustdoc to include local images in the generated documentation by copying them into the output directory.
Expand All @@ -37,8 +37,12 @@ The path could be either a relative path (`../images/my_image.png`) or an absolu

If the path isn't referring to a file, a warning will be emitted and rustdoc will left the path unchanged in the generated documentation.

Important to be noted for published crates: local resources need to be bundled with the crate so they can be retrieved by rustdoc and absolute paths won't work.
GuillaumeGomez marked this conversation as resolved.
Show resolved Hide resolved

The local resources files are not affected by the `--resource-suffix`.

The impact on `docs.rs` would also be very minimal as the size of a published crate resources is limited to a few megabytes. The only thing needed would be to handle the new `doc.files` folder.

# Reference-level explanation
[reference-level-explanation]: #reference-level-explanation

Expand Down