search

dlang / ddox

Advanced D documentation engine
MIT License
63 stars 21 forks source link

add --html-style option #166

Closed MartinNowak closed 7 years ago

MartinNowak commented 7 years ago
s-ludwig commented 7 years ago

I guess the compact setting implicitly became the default when switching to diet-ng. The question is, is this actually the best default? One one hand, compact documentation makes sense, but on the other hand when that is not a priority, the pretty setting is much nicer. What was your use case for adding the setting?

MartinNowak commented 7 years ago

I guess the compact setting implicitly became the default when switching to diet-ng. The question is, is this actually the best default? One one hand, compact documentation makes sense, but on the other hand when that is not a priority, the pretty setting is much nicer. What was your use case for adding the setting?

Diffing the test cases for ddox ;). In particular being able to check-in and diff the generated HTML would be useful. I might just change the default for generate-html, but some ppl. might want to statically serve those files. We also might resort to some external tool to prettify HTML for the testing.

wilzbach commented 7 years ago

Being able to temporarily switch back to pretty-print output would be really nice to have for https://github.com/dlang/dlang.org/pull/1891 (upgrading dpl-docs to ddox 0.16)

s-ludwig commented 7 years ago

Okay, should be good to go then. There are only a few templates, so that compiling them twice shouldn't matter much in terms of compile time and memory usage.

wilzbach commented 7 years ago

Thanks a lot! Do you by chance also plan to move this repo to the vibe-d org? It would be nice if I don't need to bother you for minor things like tagging a new alpha release ;-)

s-ludwig commented 7 years ago

I'll have to think about the satellite projects, but my idea for the vibe-d org was to keep it focused on the core components, basically as a replacement for the monolithic "vibe.d" repository. But in the meantime I sent you an invitation to the DDOX developers team (and tagged 0.16.5 ;).

wilzbach commented 7 years ago

but my idea for the vibe-d org was to keep it focused on the core components, basically as a replacement for the monolithic "vibe.d" repository

Okay, but then at least diet-ng~ and maybevibed.org` would fit the description ;-)

But in the meantime I sent you an invitation to the DDOX developers team (and tagged 0.16.5 ;).

Thanks a lot! FWIW as we plan to replace Ddoc with Ddox over the next months, we could probably even move it to the dlang namespace if that's something you are interested in.

s-ludwig commented 7 years ago

vibed.org I'd agree, diet-ng I'm not sure yet, because in the process of separating it out, it was also made fully independent of any other vibe.d components and I was thinking about giving it its own brand to broaden the scope (I already registered diet-lang.org for that purpose).

As to moving Ddox to the dlang org, that would make sense, but I'd postpone that to when it is deemed "finished" (i.e. no big changes are planned anymore). The major change that I have in mind is fully switching to the libdparse based parser to avoid all the issues with DMD's JSON output.