IssueRaiser

Include images in rustdoc output

As written by Luthaf over here https://users.rust-lang.org/t/include-images-in-rustdoc-output/3487 "Hi rustaceans! Images in documentation can be really useful to provide some insight on algorithms or modules organisation. It is already possible to insert a link to an image in documentation comment ``` /// ![Alt version](url://for/this/image.png) ``` But using this method, we only get to include images already available in some place of Internet. Is it a way to make rustdoc copy some files to the target/doc folder, so that it is easy to include specific images in the documentation? The same could go for other static files, like specific CSS or JS. Is it possible yet? If not, do you think it is worth it?" I this this would be awesome to include as sometimes using images is much easier when explain something than showing text.

Posted by emoon on Mar 7, 2016, 7:47 PM

Tags

Related issues

Raise real-world problems, find people facing the same issue, and discuss solutions.5,000 issues0 comments

github (Network)

Include images in rustdoc output

emoonMar 7, 2016, 7:47 PM

As written by Luthaf over here https://users.rust-lang.org/t/include-images-in-rustdoc-output/3487 "Hi rustaceans! Images in documentation can be really useful to provide some insight on algorithms or modules organisation. It is already possible to insert a link to an image in documentation comment ``` /// ![Alt version](url://for/this/image.png) ``` But using this method, we only get to include images already available in some place of Internet. Is it a way to make rustdoc copy some files to the target/doc folder, so that it is easy to include specific images in the documentation? The same could go for other static files, like specific CSS or JS. Is it possible yet? If not, do you think it is worth it?" I this this would be awesome to include as sometimes using images is much easier when explain something than showing text.

Comments (0)

No comments yet. Start the discussion.

Comment on this issue