martinnowak/scod

A nice documentation generator based on ddox.

scod - documentation generator

Scod is a clean and lightweight theme for ddox, simply use It as drop-in replacement.

Newer dub versions (>=0.9.25) have a switch to configure the ddox tool. The following configuration tells dub to use scod for documentation generation with dub build --build=ddox.

• x:ddoxTool "scod" (dub.sdl)
• "-ddoxTool": "scod" (dub.json)

scod's Issues

Update to ddox 0.16.0

• include static search feature
• diff diet templates

Optlink crash on Windows

When including SCOD into DUB's template project (dub init), I get a linking error when running dub run -b ddox:

---------------------------
Unexpected OPTLINK Termination at EIP=0040F60A
---------------------------
EAX=051E0000 EBX=00438C70 ECX=0000048D EDX=0000033D 
ESI=00006400 EDI=051E2DCC EBP=0019FF38 ESP=0019FEF0 
First=00402000
---------------------------

Linking...
Error: linker exited with status 17571584
dmd failed with exit code 1.

This happens with DMD32 v2.072.2 and v2.073.1. Haven't tried the versions inbetween but I suppose they also fail. This is on Windows. The build is fine when I remove SCOD. I can imagine the problem lies with the linker instead of the library.

does not currently build

experimental_allocator 2.70.0-b1: building configuration "library"...
../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/package.d(322,13): Error: std.experimental.allocator.common.Ternary at ../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/common.d(14,1) conflicts with std.typecons.Ternary at /Library/D/dmd/src/phobos/std/typecons.d(7427,1)
../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/package.d(328,13): Error: std.experimental.allocator.common.Ternary at ../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/common.d(14,1) conflicts with std.typecons.Ternary at /Library/D/dmd/src/phobos/std/typecons.d(7427,1)
../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/package.d(348,13): Error: std.experimental.allocator.common.Ternary at ../../../.dub/packages/experimental_allocator-2.70.0-b1/experimental_allocator/src/std/experimental/allocator/common.d(14,1) conflicts with std.typecons.Ternary at /Library/D/dmd/src/phobos/std/typecons.d(7427,1)

Please `dub upgrade` and tag new version

Documentation fails to build due to old vibe-d not building under newest dmd, which is due to a dependency of scod on an old ddox.

vibe-d/vibe.d#2058 (comment)

return false in toggleTree

Is there a reason toggleTree in scod.js/script.min.js returns false? This prevents users from being able to navigate to pages corresponding to package.d files, as it will instead just collapse/expand the tree viewer.

Error building eventcore

Hi! I'm trying to use scod with DMD 2.087.1, but I'm getting an error:

> dub run -b ddox 
Performing "ddox" build using /usr/bin/dmd for x86_64.
monadic ~master: building configuration "library"...
Running pre-generate commands for vibe-d:tls...
/bin/sh: line 16: rdmd: command not found
Performing "debug" build using /usr/bin/dmd for x86_64.
hyphenate 1.1.2: target for configuration "library" is up to date.
stdx-allocator 2.77.5: target for configuration "library" is up to date.
libdparse 0.8.8: target for configuration "library" is up to date.
diet-ng 1.6.0: target for configuration "library" is up to date.
mir-linux-kernel 1.0.1: target for configuration "library" is up to date.
taggedalgebraic 0.11.4: target for configuration "library" is up to date.
eventcore 0.8.44: building configuration "epoll"...
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/processes.d(305,25): Error: undefined identifier intptr_t
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/driver.d(58,41): Error: template instance `eventcore.drivers.posix.processes.SignalEventDriverProcesses!(SelectEventLoop)` error instantiating
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/select.d(26,27):        instantiated from here: PosixEventDriver!(SelectEventLoop)
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/processes.d(305,25): Error: undefined identifier intptr_t
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/driver.d(58,41): Error: template instance `eventcore.drivers.posix.processes.SignalEventDriverProcesses!(EpollEventLoop)` error instantiating
../../../.dub/packages/eventcore-0.8.44/eventcore/source/eventcore/drivers/posix/epoll.d(19,26):        instantiated from here: PosixEventDriver!(EpollEventLoop)
/usr/bin/dmd failed with exit code 1.

I assume some dependency needs bumping, but unfortunately I don't know how to test it locally.

ddox build (without scod) works.

dub.selections.json needs update for dmd 2.081.1

I fail to use scod with dmd 2.081.1, because it causes stdx-allocator to be compiled in the outdated version 2.77.1, presumably because scod's dub.selections.json pins ddox at version 0.16.10.

(Sorry for ranting OT, but I think dub.selections.json is very poorly documented, I don't understand its purpose and I understand even less the advantage of having it under version control. It's causing nothing but problems if you want to use a recent compiler... But that's not your fault.)