Things I want from a documentation tool in 2017: - Uses markdown - Generates links from module paths - Executes code examples as tests - Has mechanisms to share setup code for those examples - Provides fuzzy search Rust has 1, 2, 3, 5. Any langs better that I should know about?
-
Show this thread
-
Replying to @sgrif
I think Sphinx offers 2, 3, 4, 5. I'd say it's a shame restructured text is such a burden to author, but the ways in which it demands precision are actually very nice for writing docs, technically.
1 reply 0 retweets 1 like -
Replying to @theomn
I'd be very interested to see how it handles #4. I don't suppose you have a link? (I'm about to head out to Star Wars)
1 reply 0 retweets 0 likes -
Replying to @sgrif
There are a few variants, but the gist is you define a block which is ran but not rendered as a part of the docs: http://www.sphinx-doc.org/en/stable/ext/doctest.html#directive-testsetup …
1 reply 0 retweets 0 likes -
Replying to @theomn
Oh yeah that's not the concern. Rustdoc has that. The key is *shared* setup
2 replies 0 retweets 0 likes -
you can have a setup.rs in examples folder then use hidden "# include" in rustdoc.
1 reply 0 retweets 0 likes
This is what we do in Diesel. It's a decent stop-gap but it has a lot of problems for a variety of reasons
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.