[Mono-docs-list] Re: Mono static html docs

Joshua Tauberer tauberer@for.net
Thu, 22 Jul 2004 08:55:48 -0400

Daniel Morgan wrote:
> How do you build the static html docs?  Details please...

Sorry I didn't post other assemblies...  been busy in my spare time 
putting together a complex site with mod_mono.

First, you'll need to check out /monodoc.

In the tools directory, there's a shell script named genbasedocs.sh. 
Edit the line "for assembly in corlib;" and replace corlib with a 
space-delimited list of assemblies for which to compile docs.  The 
assemblies need to have documentation available in /monodoc/class, of 

Run make in that directory.  Run the script.  It takes a while.

> Does your tool work on Windows?

The script won't, but the underlying program that does the work, 
monodocs2html.exe, is a .NET app.  You can see how to call it from the 
script.  I've never run it in Windows, but it should work fine.

If you want to generate docs for an assembly not in /monodoc/class, use 
the monodocer.exe tool in the same directory (also created by make). 
The usage is a bit cryptic - I can explain more if needed.

Let me know if anything doesn't work as expected.

- Joshua Tauberer


** Nothing Unreal Exists **