Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #44233

Re: using pandoc instead of rst to document python

Show all headers | View raw

On Tue, Apr 23, 2013 at 5:40 PM, R. Michael Weylandt
<michael.weylandt@gmail.com> wrote:
> On Tue, Apr 23, 2013 at 6:36 PM, Peng Yu <pengyu.ut@gmail.com> wrote:
>> Hi,
>>
>> I'm wondering if it possible to use pandoc instead of rst to document
>> python. Is there a documentation system support this format of python
>> document?

Sorry for the confusion. When I said pandoc, I meant pandoc's markdown.

http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

> Pandoc is a converter while rst is a format so they're not directly
> comparable; pandoc can convert _to_ and _from_ rst to a wide variety
> of other formats, but you still have to write documentation in one
> format or another. If you want to use an rst-centric documentation
> tool, you can write in, e.g., Markdown, convert to rst and then run
> your other tool on it.

I currently use sphinx to generate the doc (in rst). How to figure it
to support pandoc's markdown?

-- 
Regards,
Peng

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Re: using pandoc instead of rst to document python Peng Yu <pengyu.ut@gmail.com> - 2013-04-23 18:14 -0500

csiph-web