Scribble cannot use include-section when developing package library

25 views
Skip to first unread message

Chen Xiao

unread,
Jun 8, 2019, 4:13:56 AM6/8/19
to Racket Users
When I developing my racket pacakge(simple-svg), I found I can't use include-section and defmodule together.

First, I split my scribble docs to separate files, and use include-section to include them.

Then I found cross reference not works.

I found when use scribble/manual to scribble package doc, it demand each section have a defmodule[package-name]!

include-section means you have multiple section in docs, so to let the cross reference work, you should add defmodule in each scribble file.

it means each section should have a defmodule.

This let cross reference work, but , it produces many annoying warnings, it said I use defmodule multiple times, yes, of course.

I tried, but don't find good ways to work this out.

So I change separate docs to a single scribble file, and move all defproc and codeblock to the subsections.

No more warnings and cross reference works.

But it make the docs looks so neat and loose the include-section power.

How to solve it? someone notice this?

Ben Greenman

unread,
Jun 8, 2019, 9:52:47 AM6/8/19
to Chen Xiao, Racket Users
In the separate files, try:

@defmodule[simple-svg #:link-target? #f]

Chen Xiao

unread,
Jun 8, 2019, 10:45:31 PM6/8/19
to Racket Users
Greenman's answer is right, resolve this problem absolutely.

在 2019年6月8日星期六 UTC+8下午4:13:56,Chen Xiao写道:
Reply all
Reply to author
Forward
0 new messages