Skip to content

Add a ddox based HTML documentation generator for dlang.org #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 15, 2013

Conversation

s-ludwig
Copy link
Member

@s-ludwig s-ludwig commented Feb 8, 2013

Adds a small tool that builds HTML documentation with a single page per entity using ddox. It is built using dub, which is available as a precompiled binary at http://registry.vibed.org/download.

Building (requires dmd, libevent-dev 2.0.x and libssl-dev to be installed):

cd dpl-docs
dub build

The tool is then used to generate the documentation from DMD's JSON output (separate pull request in the dpl.org repository).

@andralex
Copy link
Member

andralex commented Feb 9, 2013

That's awesome, thanks Ludwig. I'm not sure how to proceed with the dependency on an external binary, but we have a couple of those already. @WalterBright?

Also, is there an OSX binary available?

@s-ludwig
Copy link
Member Author

s-ludwig commented Feb 9, 2013

Added one to the download page.

I thought this is the easiest option. Another possibility would be to include the dependencies as git submodules and add a manual build script.

@mihails-strasuns
Copy link

WalterBright added a commit that referenced this pull request Jul 15, 2013
Add a ddox based HTML documentation generator for dlang.org
@WalterBright WalterBright merged commit ac67f63 into dlang:master Jul 15, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants