ddox 0.9.20
Powerful alternative to DMD's DDOC engine.
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
DDOX documentation engine
First steps
- Install dub
- Generate JSON for your project by adding the command line switches
-D -X -Xfdocs.json
to your DMD command line (Note that you may need to clean up all the generated .html files afterwards) - Check out ddox and run
dub build
from its root folder
Filtering docs
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
- Registered by Sönke Ludwig
- 0.9.20 released 10 years ago
- dlang/ddox
- github.com/rejectedsoftware/ddox
- MIT
- Authors:
- Dependencies:
- vibe-d
- Versions:
-
0.16.23 2024-Mar-03 0.16.22 2023-Apr-05 0.16.21 2023-Feb-17 0.16.20 2022-Jul-29 0.16.19 2022-Jun-17 - Download Stats:
-
-
100 downloads today
-
546 downloads this week
-
1658 downloads this month
-
412087 downloads total
-
- Score:
- 4.0
- Short URL:
- ddox.dub.pm