the new documentation system

hi, as you know I'm working to a new documentation system. Now the documentation of the xmonad-contrib library is generated with haddock and store in the XMonad.Doc name space. I created four files: XMonad.Doc.hs XMonad.Doc.Configuring.hs XMonad.Doc.Extending.hs XMonad.Doc.Developing.hs The first is a brief overview of xmonad, and links to the other files. The second, almost done, is a brief tutorial on how configuring xmonad. The third (Extending.hs) is a description of the library content and a more detailed guide to configuring xmonad. The manageHook and the logHook are still to be documented, also because I'm waiting for the new interface with the monoid instance. The forth is a brief commentary to the core code to be used as an introduction to writing new extensions. I also started to port each module to the new documentation system. This is what I'm doing: - libraries for other modules: a brief documentation and a couple of links to modules using the library. - actions to be linked to some key binding: an example of the key binding (it must be possible to paste the example in the .xmonad/xmonad.hs file) with a link to XMonad.Doc.Extending#Editing_key_bindings - layouts: an example of layoutHook and a link to XMonad.Doc.Extending#Editing_the_layout_hook - hooks: this should link to the appropriate section of XMonad.Doc.Extending (still to be done). The XMonad.Util, XMonad.Prompt are almost done. I'm almost done with XMonad.Layout. The documentation is linked to the colorized (with hscolour) source. Here the results: http://gorgias.mine.nu/xmonad/xmonad-contrib/index.html You can use it as an example for documenting modules without updated docs. If you want to help you can: - start fixing modules starting from the XMonad.Action name space (not to interfere with me); - check for typos; - rephrase and modify when you think my English is not clear (it is not my mother tongue); - correct mistakes. Thanks for your help. Andrea

On Wed, Nov 21, 2007 at 07:57:10PM +0100, Andrea Rossato wrote:
The XMonad.Util, XMonad.Prompt are almost done. I'm almost done with XMonad.Layout.
The documentation is linked to the colorized (with hscolour) source.
Here the results: http://gorgias.mine.nu/xmonad/xmonad-contrib/index.html
Awesome work! If you're in the mood for meta-documentation, I'd love to read details on the toolchain necessary to generate these. IIRC, you using ghc 6.8 and darcs haddock? Any other gotchas? With these installed, does Setup.lhs haddock work as expected? _Maybe_ that would encourage me to actually contribute, but no promises. :)

On Thu, Nov 22, 2007 at 12:57:28AM -0500, Devin Mullins wrote:
Awesome work! If you're in the mood for meta-documentation, I'd love to read details on the toolchain necessary to generate these. IIRC, you using ghc 6.8 and darcs haddock? Any other gotchas? With these installed, does Setup.lhs haddock work as expected?
_Maybe_ that would encourage me to actually contribute, but no promises. :)
Sure! All you need is haddock-ghc (haddock-0.8 is fine too, but there's an annoying bug with the X newtype deriving -in XMonad.Core - which requires a very small patch). IIRC XMC docs should be generated without problem. You can get haddock-ghc from: http://code.haskell.org/haddock That's it: Setup.lhs haddock should be working fine... ... almost. There seems to be an issue with that darcs version and the option --hyperlink-source, which means: no links to the source code are possible (and so no hscolour). Haddock-0.8 works fine in that regard. Hope this helps, Andrea

Hi, an update. - XMnad.Util.*, XMonad.Prompt.* and XMonad.Layout.* are done. XMonad.Config.* are just example and I will not touch them but mine. - XMonad.Doc and XMonad.Doc.Configuring are (almost) done What is left: 1. XMonad.Doc.Extending: manageHook and logHook. 2. XMonad.Doc.Developing: everything but I have clear ideas on this document. 3. XMonad.Action.*: many are still to be done; 4. XMonad.Hooks.*: I'll do them tonight. That's it. Andrea
participants (2)
-
Andrea Rossato
-
Devin Mullins