Quickly

Generate user documentation using Mallard

Bug #512723 reported by Philip Peitsch
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Quickly
Fix Released
Wishlist
Tony Byrne
Quickly 11.03

Bug Description

Gnome uses a program called Mallard (http://projectmallard.org/) to generate help files from mark-up. I think it would be helpful to stub out an example documentation file, and integrate generation of the resulting documents into the quickly build chain. I suspect some of this might be pushed up into python-distutils-extra.

Revision history for this message
Shane Fagan (shanepatrickfagan) wrote :

Gnome hasnt migrated fully to Mallard yet and ubuntu still uses Docbook so I think this one may be for the future.

Revision history for this message
Philip Peitsch (philip-peitsch) wrote :

Ahh. I didn't realise! Potentially it might be handy to support Docbook first then? I'm actually not too fussed on which format or system is used... just as long as it can be easily handled as part of the Quickly system (as in compiling out to the final binary forms, etc.)

Revision history for this message
Didier Roche-Tolomelli (didrocks) wrote :

As we discussed together, this is clearly the long term way to go.

If you can keep an eye on it, it would be awesome! Thanks again for all your work on Quickly :)

Changed in quickly:
status: New → Triaged
importance: Undecided → Wishlist
Revision history for this message
Didier Roche-Tolomelli (didrocks) wrote :

Hum, it seems that in fact mallard documentation is available in new GNOME, maybe time to convert the Quickly documentation to it?
http://bobthegnome.blogspot.com/2010/02/mallard-documentation.html

Revision history for this message
Didier Roche-Tolomelli (didrocks) wrote :

some pointers from james_w:
http://projectmallard.org/about/learn/index.html
http://gitorious.org/empathy-mallard/empathy-mallard

Revision history for this message
Philip Peitsch (philip-peitsch) wrote :

I'll take a crack at it tonight and see how far I get :)

Philip Peitsch (philip-peitsch)
Changed in quickly:
assignee: nobody → Philip Peitsch (philip-peitsch)
status: Triaged → In Progress
Revision history for this message
Michael Terry (mterry) wrote :

This got done by Tony recently.

Changed in quickly:
assignee: Philip Peitsch (philip-peitsch) → Tony Byrne (tony-badwolf)
status: In Progress → Fix Committed
Michael Terry (mterry)
Changed in quickly:
milestone: none → 11.03.0
Michael Terry (mterry)
Changed in quickly:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.