Generate HTML versions of man pages

04f761b
Opened by Brian Anderson at 2023-09-15 20:26:16

man pages contain useful information that isn't accessible on windows. rustup concerns itself with man pages and will have a rustup man feature that is useless on windows. I'd like be able to show the same information by opening up a browser to the installed docs.

Can we find a way to generate both the man pages and new HTML versions of the command line documentation from the same source? We probably don't want to take a new pandoc dependency. Perhaps we can just write something in Rust to do it.

Alternately, we could create HTML documentation for each of the command line tools. In the future we're going to be distributing more command line tools. They'll need to be documented in HTML.

  1. IIRC, npm does this.

    @ashleygwilliams how does that infrastructure work? It's all generated from markdown, yeah?

    On Jul 1, 2016, 21:24 -0400, Brian Andersonnotifications@github.com, wrote:

    man pages contain useful information that isn't accessible on windows. rustupconcerns itself with man pages(https://github.com/rust-lang-nursery/rustup.rs/issues/490)and will have arustup manfeature that is useless on windows. I'd like be able to show the same information by opening up a browser to the installed docs.

    Can we find a way to generate both the man pages and new HTML versions of the command line documentation from the same source? We probably don't want to take a new pandoc dependency. Perhaps we can just write something in Rust to do it.

    Alternately, we could create HTML documentation for each of the command line tools. In the future we're going to be distributing more command line tools. They'll need to be documented in HTML.

    — You are receiving this because you are subscribed to this thread. Reply to this email directly,view it on GitHub(https://github.com/rust-lang/rust/issues/34607), ormute the thread(https://github.com/notifications/unsubscribe/AABsihEdVP-9ecLD4t90tdibOCCuG679ks5qRb2_gaJpZM4JDkrc).

    Steve Klabnik at 2016-07-02 05:55:10

  2. untagging as docs as this isn't really our work to do

    Steve Klabnik at 2017-08-30 19:15:13