racket

How to compile Racket Doc source file


I have downloaded the source for Racket Guide to learn how it has been documented. I wanted to make changes and see how it reflects in the rendered html.

I need help in compiling the source for Racket Guide.

Could you please help me?


Solution

  • When you said you "downloaded the source", what do you mean by that?

    One way to setup Racket (and its docs) for modification is to:

    $ git clone https://github.com/racket/racket
    $ cd racket
    $ make # The first run could take long time depending on your hardware. Mine took 25 mins, with multithreading enabled.
    

    This will build the entire Racket and its documentation. Then, you can modify the doc. For example, to modify the Racket Guide, you should change stuff in pkgs/racket-doc/scribblings/guide. After that, run make again to render the change. You can view the updated documentation via raco docs.