Export documentation to web

Yesterday on IRC someone asked how they could create a site like http://docs.gotmono.net/ containing documentation for their project, so I spent a little bit of time making it really easy.

$ svn co https://svn.extremeboredom.net/Monique/trunk ./Monique
cd Monique
./autogen.sh
make
make run

(WARNING! I have NOT tested “make install” so I don’t recomend trying it. I have no idea what will happen.)

Once Monique starts, add some documentation sources from the Preferences window. You’ll probably want to use the Compiled Monodoc provider.

Once you have the documentation you want to export loaded, press the “Export to Web” button on the toolbar.

Set the options and press OK. After a few seconds, assuming all goes well, it will say that it’s done exporting and ask you if you would like to test the site. You’ll need XSP installed for this to work, and assuming you’ve got it, you will end up with this:

Monique was a fork of monodoc I used as a playground. It never went anywhere, and the GTK documentation viewer is compltely worthless. Hopefully I will have to time to merge all of this into the main monodoc tree soon. Unless you want to help, please don’t ask me about it.

Have fun…

Post a Comment

Your email is never published nor shared. Required fields are marked *

*
*