ddox icon indicating copy to clipboard operation
ddox copied to clipboard

Customizing the output beyond just CSS?

Open Abscissa opened this issue 10 years ago • 4 comments

Is there a way to customize the ddox html templates (or at least headers/footers/titles) other than just forking ddox and editing the views in the fork?

Abscissa avatar Jun 28 '15 00:06 Abscissa

It's possible to override templates by adding a file with the same name in a dependent project. See for example https://github.com/rejectedsoftware/vibed.org/blob/master/views/ddox.layout.dt

s-ludwig avatar Jul 20 '15 13:07 s-ludwig

Hmm, that's not working for me. Using ddox 0.10.8, I created a views directory at the base of my project, copied into it the ddox.layout.dt file from ddox, modified my copy of ddox.layout.dt and then rebuilt my docs (from the base directory of my project). But the changes are not reflected in the output.

Abscissa avatar Jul 31 '15 15:07 Abscissa

I have the same issue, which I suspect is because doing dub run ddox doesn't re-compile any templates.

It would be useful to e.g. be able to generate/specify a more interesting landing page, for instance. Just saying "here, these are the modules" is not very user-friendly documentation, so being able to include some text there by default would be great.

urdh avatar Oct 02 '15 20:10 urdh

I want to start generating my code's documentation with ddox, but my comments include LaTeX equations, which I currently prettify by using the MathJax JS library. Trying to include this in my ddox documentation I also ran into this problem. Changing layout.dt seemed like a good start, but it is not being included. Any improvements would be appreciated.

SFrijters avatar Dec 11 '15 13:12 SFrijters