jakobovrum / bootdoc Goto Github PK

Direct symbol links are currently fully qualified, but there's no way to specify a specific overload.

It would be nice to be able to specify an output root directory to the generation script.

I find myself wanting this for the Phobos documentation all the time.

I originally tried using a span class on the parameter name row but it created some nasty word wrapping issues.

The generation script should probably return an exit code of 2 when no action is performed (i.e. the help is displayed).

I think is useful

 #!/usr/bin/env rdmd

to generate.d and giving it executable right.
Then

$ ./bootDoc/generate.d

will work.
Maybe even better add a file named bootdoc.d. If I add the folder to my PATH I can to ./bootdoc.d.

What do you think?

bad tree expand when goto package.d file (no any expands)

I fail to understand how bootDoc works together with a gh-pages branch. Assuming bootDoc is a submodule in that branch. Then generating rdmd bootDoc/generate.d ../src won't work as the src/ is only in the master branch.
I tried to verify how it is supposed to work using https://github.com/JakobOvrum/LuaD/ like this:

$ git clone https://github.com/JakobOvrum/LuaD.git
$ git checkout gh-pages
$ rdmd bootDoc/generate.d .. --extra=index.d

The last gives me:
Error: cannot read file ../luad/all.d
Error: cannot read file ../luad/state.d
Error: cannot read file ../luad/base.d
...

Examples:

Many links point to sites that do not exist. This may detract potential users that might come to conclusion that bootDoc is not maintained and is outdated.

In particular cuteDoc and bootstrap links are dead.

Or write a patch to DDoc to make it respect DDOC_PSYMBOL for these special members...

If you pass --extra=../index.ddoc, the generation script attempts to assemble this to ...index.html.

This is kind of tedious.

Examples:

• http://jakobovrum.github.com/bootdoc-phobos/std.json.html#JSON_TYPE.STRING
• http://jakobovrum.github.com/bootdoc-phobos/std.parallelism.html#scopedTask

As a result it's hard to click in a browser.

It seems like most of them should be moved to the Phobos demo repository's settings.ddoc as they are project-specific, but some of them are universally useful.

These are my suggestions: RPAREN, LPAREN, LESS, GREATER, D and BIGOH.

It would also be nice to have standard symbol referencing and cross-module referencing macros, but I'm not sure what the optimal implementation of them is.

The BUGZILLA macro is also interesting, and I think it'd be cool to have a standard macro named BUGTRACKER or something where the URL is configured in settings.ddoc.

Not sure where to put it, but I think Phobos docs are mandatory for DDoc themes these days.

@JakobOvrum, I haven't used bootDoc yet, but I am quite impressed with the phobos demo. I was wondering if it is possible to generate markdown instead of pure html? Like one .md file per module that lists everything. This will be great for smaller code bases that don't need a whole website(or gh-pages branch) and can just place a README.md file in the module's folder.

Also does bootDoc use DDoc or is it completely separate from DDoc?

generate.d already supports this.

Need to find a good replacement for the Bootstrap caret or something.

Often a class for a module might be documented in the module comment/header and the class itself has no actual documentation header. However it's members do have documentation, yet the whole class is not mentioned.

Regularly I forget adding new modules to modules.ddoc. Is there any way to automate this process?