A few comments and questions from a newby.

I started my project's documentation using markdown with pandoc. I couldn't get 
any of the TOC options I found to work correctly, so I had to write my own TOC 
generator.

Then I noticed that nim supported rst with its doc and rst2html commands, so I 
painfully switched my doc files to that. At least that has a nice TOC generator 
- once you guess at the required directive. Since my main module html file as 
produced by doc needs to hyperlink to sections in another hand-written "user 
guide" file, I had to hack the rst notation and write an html modifier to 
translate section headings into the mangled labels produced by the nim command 
rst2html.

So I have these questions:

  * How soon could an alternate docgen be available to produce nim module 
documentation?
  * Is that even likely?
  * Would this docgen reliably generate a TOC for nim modules?
  * Would this docgen generate (and use) an index file for easy hyperlink 
creation? I.e. like the --index:on feature currently in nim.


Reply via email to