File: README.org

package info (click to toggle)
racket-mode 20250711~git.8a80578-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,024 kB
  • sloc: lisp: 17,215; makefile: 106
file content (26 lines) | stat: -rw-r--r-- 946 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
* Documentation

#+BEGIN_SRC picture

 +-----------------+
 | racket-mode.org |     +---------------+      ---------------
 | #!INCLUDE:      |--<--| reference.org |--<--/ generate.el  /---<--{doc strings}
 +-----------------+     +---------------+     ---------------
        |
        |       +------------------+       +------------------+
        +--->---| racket-mode.texi |--->---| racket-mode.info |
        |       +------------------+       +------------------+
        |
        |       +------------------+
        +--->---| racket-mode.html |
                +------------------+

#+END_SRC

Note that for Info documentation, we actually commit just the
~racket-mode.texi~ file so that MELPA can deliver it. We let
~package-install~ generate the ~.info~ file. (At least, I /think/
that's how it's supposed to work.)

Tip: As a developer, to review the ~racket-mode.info~ locally, just
use a prefix with the info command: ~C-u C-h i~.