On Mon, Oct 1, 2018 at 11:06 PM Jenny B. Schaffer <[email protected]> wrote:
Hi, But I've never used it! > > Two questions: > > 1. Is there a good basic tutorial or website to get it configured and > running? > http://www.sphinx-doc.org/en/master/contents.html (and the rest of http://www.sphinx-doc.org/) Also because the Sphinx documentation is written in ... you guessed it ... Sphinx, you can get the source code for pages of documentation that you find particularly clever and say "Ohhh. I see how they did that... Cool!" 2. Our existing documentation is very minimal (just a handful of short > chapters), and it is in markdown (.md). I know there's a migration path > from .md to Sphinx but it might be just as easy to create files anew and > copy and paste (I'm not kidding). How hard or easy is the migration? > Since Sphinx works off of reStructured Text (RST) the Pandoc tool ( https://pandoc.org/) is a good start. It tries to convert anything to anything including Markdown and reStructured Text. Available for Linux, Windows and Mac OS X. See the Installing page from the menu on the left of the main page. (There will probably be a bit of tweaking involved, post-conversion if, for example you choose a particular style for your Sphinx documents that is not whatever generic style pandoc offers you.) -- Physical [image: [Photo: Kevin Cole]] Kevin Cole, RHCE <http://launchpad.net/~kjcole/> Team Contact Ubuntu Linux DC "LoCo" <http://dc.ubuntu-us.org/> Washington, DC (US) Virtual E-mail: kjcole (at) ubuntu•com WWW: http://dc.ubuntu-us.org/ GPG Key ID: 0x3E696927 <http://research.gallaudet.edu/~kjcole/pubkey.php> -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
