Doctool Tintin

[pietervdvn]

(MarkUp spec moved to #84 )

Keep in mind

• Simplicity
• User friendlyness
• Documentation of the doctool
• The base idea is literate programming with MD-syntax
• Stealing ideas is good

Generated docs should have modes for:

• Showing/hiding actual source code
• A 'API'-documentation mode (for users of the lib) and a 'internal'-docmode, for developers wanting a internal overview
• [x] Have a look at pandoc source (http://hackage.haskell.org/package/pandoc-1.13.2/docs/Text-Pandoc.html)
• [ ] Have a look at Haddock output
• [ ] Have a look at java docs
• [ ] Have a look at django docs

  Doc spec

• [ ] Doc format spec:
  • [ ] What is synopsis? First line? Sentence? Paragraph?
  • [ ] Official codes for emph, important, images, links, rollover, expand...
  • [ ] See Daring fireballs MD syntax
  • [ ] Argument tags etc
  • [ ] No code ownership tags! This is handed by the manifest!
  • [ ] Documentation rehousing guide! Functions that are re-exported, where do these docs go?
• [ ] Mardown parser -> MarkUp
• [ ] Link downloader. All linked images and websites should be saved to doc/res, needed metainfo should be added to doc/res/Sources, links should be rewritten while rendering. Format is free, bonus points if languate.

  Actual pages to generate

• [ ] Todo overview (nice warmup)
• [ ] Index page
• [ ] Type overview page
  • [ ] Link to defining module
  • [ ] Docstring (synopsis + description)
  • [ ] Supertypetable (natives: explicit, calculated if clicked open)
• [ ] Module overview
• [ ] Side bar to navigate