{"version":"https://jsonfeed.org/version/1","title":"Read Rust - rustdoc","home_page_url":"https://readrust.net/","feed_url":"https://readrust.net/tags/rustdoc.json","description":"Posts tagged 'rustdoc' on Read Rust","author":{"name":"Wesley Moore","url":"https://www.wezm.net/"},"items":[{"id":"85880050-b10b-4dff-8e8d-9ebe0ba9dac1","title":"Improvements for #[doc] attributes in Rust","content_text":"Since Rust 1.54, we can now use function-like macros in attributes. It has a lot of advantages for the #[doc] attribute, let's check some of them!","url":"https://blog.guillaume-gomez.fr/articles/2021-08-03+Improvements+for+%23%5Bdoc%5D+attributes+in+Rust","date_published":"2021-08-03T22:32:48Z","author":{"name":"Guillaume Gomez"},"tags":["Language"]},{"id":"68f358a2-f572-4e15-a120-9a8dcf451b91","title":"Announcing rusty-man, a command-line viewer for rustdoc documentation","content_text":"rusty-man is a command-line viewer for documentation generated by rustdoc. It parses the HTML output of rustdoc, searches for a given keyword and formats the documentation similar to a manpage.","url":"https://users.rust-lang.org/t/announcing-rusty-man-a-command-line-viewer-for-rustdoc-documentation/46315","date_published":"2020-07-25T10:05:32Z","author":{"name":"ireas"},"tags":["Tools and Applications"]},{"id":"027f181e-6f32-415d-804f-236d005a4628","title":"Documentation and unstable rustdoc features","content_text":"This blog post is a zoom in into one subject of the Guide and Tips for crate publishing. It’s about managing your documentation and more specifically about using two unstable features of rustdoc: external_doc, doc_cfg.","url":"https://blog.wnut.pw/2020/03/24/documentation-and-unstable-rustdoc-features/","date_published":"2020-03-25T02:12:32Z","author":{"name":"Naja Melan"},"tags":["Language"]},{"id":"15a7e3a3-5777-405f-abde-99e0e23667ce","title":"Guide on how to write documentation for a Rust crate","content_text":"I have received (a lot of) demands about writing a guide on how to write documentation in Rust lately. I'm quite happy that people finally gets interested into this area so let's not let it rest and let's go!","url":"https://blog.guillaume-gomez.fr/articles/2020-03-11+Guide+on+how+to+write+documentation+for+a+Rust+crate","date_published":"2020-03-12T21:35:43Z","author":{"name":"Guillaume Gomez"},"tags":["Language"]},{"id":"84299ed7-628d-45bc-8a77-ceeaa5151d37","title":"cfg(doctest) is stable and you should use it","content_text":"I arrive a bit late considering that #[cfg(doctest)] is stable since rust 1.40 but I think\r\nit's important for people to know about this feature and how to use it.\r\n\r\nFirst things first, what is this feature about and when is it set? The answer: when running rustdoc --test (or cargo test on the doc subpart).","url":"https://blog.guillaume-gomez.fr/articles/2020-03-07+cfg%28doctest%29+is+stable+and+you+should+use+it","date_published":"2020-03-11T07:05:16Z","author":{"name":"Guillaume Gomez"},"tags":["Language"]}]}