ddox documentation generator

Sönke Ludwig sludwig at outerproduct.org
Thu Oct 11 09:14:26 PDT 2012


Am 10/10/2012 5:12 PM, schrieb Mr. Anonymous:
> On Sunday, 7 October 2012 at 16:18:27 UTC, Sönke Ludwig wrote:
>> The documentation generator used for vibed.org (e.g.
>> http://vibed.org/api/vibe.core.file/FileStream) is now available as a
>> stand-alone project:
>>
>> https://github.com/rejectedsoftware/ddox
>>
>> also available as a VPM module:
>> http://registry.vibed.org/view_package/ddox
>>
>> Features:
>>
>>  - Supports DDOC sections and macros
>>  - Fully interlinked types
>>  - Automatically inherits members and documentation from base classes
>>  - Clean structure without endless spaghetti pages (customizable)
>>  - Diet template based and thus fully customizable output
>>  - Built-in HTTP server for local docs serving
>>  - Easily embeddable into existing vibe.d based sites
>>  - Can generate offline documentation as HTML files
>>  - Function for filtering the DMD .json file by module prefixes,
>> protection level and doc comment
> 
> Can it be used for Phobos documentation on dlang.org?
> 
> Also see my previous post, "Getting started with D - Phobos
> documentation sucks":
> http://forum.dlang.org/thread/pctnuoxbqzyuazivpvwx@forum.dlang.org

I generated some docs and put them here:
http://vibed.org/temp/phobos/index.html

It works (there are warnings during generation, so maybe a few details
are missing), but could look better, as the docs are quite tailored
towards their current representation/layout in some parts.


More information about the Digitalmars-d-announce mailing list