Powerful alternative to DMD's DDOC engine.
To use this package, put the following dependency into your project's dependencies section:
DDOX documentation engine
- Install dub
- Generate JSON for your project by adding the command line switches
-D -X -Xfdocs.jsonto your DMD command line (Note that you may need to clean up all the generated .html files afterwards)
- Check out ddox and run
dub buildfrom its root folder
You can filter the JSON file using
ddox filter <path_to_json>.
The following command will filter out all modules starting with "core.sync.", except those starting with "core.sync.mutex" or "core.sync.condition".
--in always takes precedence over
--ex here. Additionally, all members with a protection lower than public will be filtered out.
./ddox filter path/to/docs.json --ex core.sync. --in core.sync.mutex --in core.sync.condition --min-protection Public
Serving the docs on localhost
Simply run the following command and go to http://127.0.0.1:8080/
./ddox serve-html path/to/docs.json
Generating offline documentation
The following command will generate HTML docs in the folder "docs":
./ddox generate-html path/to/docs.json destination/path
0.16.12 2018-Jul-15 0.16.11 2018-Jul-06 0.16.10 2018-Apr-07 0.16.9 2018-Mar-21 0.16.8 2018-Jan-25
- Download Stats:
125 downloads today
801 downloads this week
3317 downloads this month
109687 downloads total
- Short URL: