Skip to content
  • David Johnson's avatar
    Documentation. · 20280bcf
    David Johnson authored
      cd doc && make
    
    You'll need pandoc, doxygen, and pdflatex.
    
    After a quick survey of current best tools that 1) generate docs in HTML
    and PDF; 2) use simple markup of ascii text for source; 3) pretty, easy
    generation -- I came up with two tools: sphinx and pandoc.  I ended up
    with pandoc; sphinx seemed a little too python-oriented, and it uses rST
    (restructured text), which seemed more cumbersome and less commonly-used
    than Markdown.  Plus, all the cool kids are using Markdown.  Plus,
    pandoc can basically transform anything to anything... so if we wanted
    something else in the future, migration would be minimally intrusive.
    Finally, I know Eric can't argue with pandoc cause it's Haskell.
    
    pandoc's primary problem is really a markdown problem.  There's no way
    to effectively build documents from multiple files, and have them
    chapterized differently depending on which document (i.e., singlepage
    HTML mode vs one-page HTML mode); this is really
    because Markdown has no "include" power (nor a rela...
    20280bcf