On 21 June 2013 10:14, Masklinn <[email protected]> wrote: > On 2013-06-21, at 03:02 , Brian Anderson wrote: > > On 06/20/2013 04:44 PM, Daniel Micay wrote: > >> On Thu, Jun 20, 2013 at 7:30 PM, Brian Anderson <[email protected]> > >> wrote: > >> Another thing to consider is switching to sphinx and avoiding the pain > >> of doing this all ourselves. Converting our markdown to restructured > >> text would be pretty trivial. > > > > I guess if we're going to switch to sphinx now is the time, but I haven't > > looked at it. Their web page does make it sound fairly python-centric > > though. > > It was created for Python and is developed in Python (so is the > underlying docutils library for processing restructuredtext), so the > main community using it is the Python community, but sphinx isn't python > specific at all. Most of the markup is generic text things, it bundles > non-python domains[0] (code coloration uses pygments so it already does > way more than just python) and there is an API for creating new domains, > you can find examples of such new domains as part of sphinx-contrib[1]. > > Switching rust's documentation to sphinx would likely require developing > a Rust domain so Sphinx can create all the right cross-references, e.g. > :func:`str::each` linking to the right place without requiring further > efforts by the documentation author.
FWIW, LLVM switched to Sphinx http://lists.cs.uiuc.edu/pipermail/llvmdev/2010-August/033737.html _______________________________________________ Rust-dev mailing list [email protected] https://mail.mozilla.org/listinfo/rust-dev
