View mode: basic / threaded / horizontal-split · Log in · Help
October 07, 2012
ddox documentation generator
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
October 07, 2012
Re: ddox documentation generator
On 2012-10-07 18:06, 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
>

This looks awesome.

-- 
/Jacob Carlborg
October 07, 2012
Re: ddox documentation generator
Server overloaded? Trying to connect to 'vibed.org' just hangs
(without actually timing out, at least not yet).
October 07, 2012
Re: ddox documentation generator
On 10/07/2012 05:33 PM, Nick Sabalausky wrote:
> Server overloaded? Trying to connect to 'vibed.org' just hangs
> (without actually timing out, at least not yet).

Same for me.
October 08, 2012
Re: ddox documentation generator
Am 10/7/2012 11:33 PM, schrieb Nick Sabalausky:
> Server overloaded? Trying to connect to 'vibed.org' just hangs
> (without actually timing out, at least not yet).
> 

Yeah.. it always has to happen when something gets announced and at
night (running for months without any problem). The proxy process hung,
only reacting to KILL.
October 08, 2012
Re: ddox documentation generator
Am 10/8/2012 9:29 AM, schrieb Sönke Ludwig:
> Am 10/7/2012 11:33 PM, schrieb Nick Sabalausky:
>> Server overloaded? Trying to connect to 'vibed.org' just hangs
>> (without actually timing out, at least not yet).
>>
> 
> Yeah.. it always has to happen when something gets announced and at
> night (running for months without any problem). The proxy process hung,
> only reacting to KILL.
> 

Btw. I have some serious memory consumption problems during compilation
and swap was not enabled on the server. I noticed that somtimes
processes got killed while the compiler was run. I hope this was the
reason for the hanging process as well - at least I recompiled several
times around the time when this happened.
October 08, 2012
Re: ddox documentation generator
Am 10/8/2012 9:29 AM, schrieb Sönke Ludwig:
> Am 10/7/2012 11:33 PM, schrieb Nick Sabalausky:
>> Server overloaded? Trying to connect to 'vibed.org' just hangs
>> (without actually timing out, at least not yet).
>>
> 
> Yeah.. it always has to happen when something gets announced and at
> night (running for months without any problem). The proxy process hung,
> only reacting to KILL.
> 

It turned out that this was due to a workaround I made to get
std.zlib.UnCompress work reliably (well, not quite, obviously).

http://d.puremagic.com/issues/show_bug.cgi?id=8779
October 10, 2012
Re: ddox documentation generator
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
October 11, 2012
Re: ddox documentation generator
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.
October 11, 2012
Re: ddox documentation generator
There were still some bugs and inconsistencies with how DMD handles DDOC
macros. I've uploaded a fixed version, also with syntax highlighting
enabled in text sections*. std.algorithm for example now also has its
overview table (with invalid links of course):

http://vibed.org/temp/phobos/std/algorithm.html

Generally, the phobos docs look much better now.

* you may need to press F5 to reload the style sheet
« First   ‹ Prev
1 2
Top | Discussion index | About this forum | D home