Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread Simon Hengel
I just finished writing my GSoC proposal and I want to have some feedback from the community. I'll try to be brief (this is not the proposal). So where is the proposal? Is there a ticket on GSoC trac? Cheers, Simon ___ Haskell-Cafe mailing list

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread David Waern
2010/4/9 Johan Tibell johan.tib...@gmail.com: On Fri, Apr 9, 2010 at 4:35 AM, Mark Lentczner ma...@glyphic.com wrote: On Apr 8, 2010, at 6:55 PM, ViaToR (Alvaro V.) wrote: I just finished writing my GSoC proposal ... The project is about creating a new documentation tool for Haskell

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread David Waern
2010/4/9 ViaToR (Alvaro V.) alv...@gmail.com: Hello, I just finished writing my GSoC proposal and I want to have some feedback from the community. I'll try to be brief (this is not the proposal). The project is about creating a new documentation tool for Haskell projects, like Sphinx[1] for

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread Alvaro Vilanova Vidal (viator)
1) Two places containing the API reference. In your example documentation the API reference is included in one of the chapters. Wouldn't it be better to just have it in one place - the Haddock docs? The example is just a test of how you could create a full-customizable single document which

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread David Waern
2010/4/9 Alvaro Vilanova Vidal (viator) alv...@gmail.com: 2) Integration with Haddock docs. I think it would be best if the pages generated by this system and the pages generated by Haddock would be integrated as much as possible - both style wise (sharing CSS, structure, headers, footers,

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread Evan Laforge
3) Configuration I haven't looked at this yet but I suspect people will not want another configuration file in their projects. Perhaps you could propose some kind of Cabal integration instead. It would be a shame if I had to figure out how to write a cabal file for my project and replace the

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread Kyle Murphy
Just a FYI, there's currently an ongoing discussion in the web-devel mailing list about the woeful state of documentation in the world of Haskell web development, and Haskell in general. It seems like some good might come of combining these two discussions as they both seem to be heading in a

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-09 Thread David Waern
2010/4/9 Alvaro Vilanova Vidal (viator) alv...@gmail.com: 3) Configuration I haven't looked at this yet but I suspect people will not want another configuration file in their projects. Perhaps you could propose some kind of Cabal integration instead. That would be awesome. I have to see

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-08 Thread Mark Lentczner
On Apr 8, 2010, at 6:55 PM, ViaToR (Alvaro V.) wrote: I just finished writing my GSoC proposal ... The project is about creating a new documentation tool for Haskell projects,... I've taken a brief look and this looks lovely. I'm currently deep at work on re-coding the Haddock backend to

Re: [Haskell-cafe] GSoC Project: A Haddock + Pandoc documentation tool

2010-04-08 Thread Johan Tibell
On Fri, Apr 9, 2010 at 4:35 AM, Mark Lentczner ma...@glyphic.com wrote: On Apr 8, 2010, at 6:55 PM, ViaToR (Alvaro V.) wrote: I just finished writing my GSoC proposal ... The project is about creating a new documentation tool for Haskell projects,... I've taken a brief look and this