Use pandoc as documentation generator

Question

I saw in a wikipedia page (Comparison of documentation generators) that pandoc can be used as a Documentation Generator (like doxygen does).

But I didn't find in pandoc's documentation or in it's site a way to extract documentation from source code comments, as others documentation generator does.

So how can I use pandoc to do this? There is a way to extract pandoc's markup language from code comments and create a PDF or HTML document from it? Or the wikipedia's comparison list is wrong?

some work needed, like: ucalgary.ca/rzach/blog/2014/05/…

mb21
– mb21

2014-07-22 18:22:54 +00:00
Commented Jul 22, 2014 at 18:22 — mb21
– mb21, Commented Jul 22, 2014 at 18:22

z-- · Accepted Answer · 2014-07-24 22:06:50Z

Taking the method described in http://www.ucalgary.ca/rzach/blog/2014/05/simple-way-to-document-code-with-markdown-grep-and-pandoc.html as mb21 mentions a bash script like the one below does the job

"makedoc" #!/bin/bash grep -e "^%" -e "^$$" $1.tex | cut --bytes=3-| pandoc -f markdown -o $1.pdf

Collectives™ on Stack Overflow

Use pandoc as documentation generator

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related