racket / racket/scribble

scribble/lp2 doesn't generate links inside @code or @codeblock

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

Running the file manual.scrbl below through scribble --html --dest docs/. +m --redirect-main http://docs.racket-lang.org/ manual.scrbl does not generate links for the display identifiers inside @code and @codeblock.

Just changing #lang scribble/lp2 to #lang scribble/manual makes them clickable in the resulting html.

#lang scribble/lp2

@(require scribble/doclang
          scribble/manual
          scribble/html-properties
          (for-label (only-meta-in 0 racket))
          (only-in scribble/private/lp chunk CHUNK))

@code[#:lang "racket"]{(display 42)}

@codeblock{
#lang racket
(display 42)
}

@chunk[<*> (void)]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with manual.scrbl using the documented scribble --html command and inspect the generated HTML for the @code and @codeblock examples. Compare the output after changing #lang scribble/lp2 to #lang scribble/manual; done means display identifiers in both examples generate links under scribble/lp2.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.