Commit Graph

31 Commits

Author SHA1 Message Date
Greg Hendershott
6aa6dc0400 Add a Markdown rendering mode to Scribble.
Uses "Github flavored markdown". Specifically, code blocks are opened
using ```scheme so that Github will lex and format them as Scheme code
rather than generic monospace.

Note: I would have used ```racket, but we are still waiting for the
pygments.rb project to pull again from pygments-main -- to which I
contributed a Racket lexer back in August. After pygments.rb pulls,
can update this to use ```racket instead.
2012-12-09 15:17:36 -07:00
Matthew Flatt
a73dc50224 break cross-reference info for document into pieces
For example, the cross-reference information for the
Reference is now broken into about 16 pieces, so that
resolving a cross-reference into the Reference doesn't
require loading all cross-reference information for
the Reference.

Every document is split into two pieces, so that the title
of a document is roughly in its own piece. That way,
re-building the page of all installed documentation can be more
scalable (after some further changes).
2012-11-23 18:44:51 -07:00
Matthew Flatt
8c1b5db815 raco setup: build database mapping doc tags to "out.sxref"s
The `xref' produced by `setup/xref' uses the database to delay
loading "out.sxref"s, which cuts 64-bit DrRacket's initial
footprint by around 50MB (i.e., about 20%).
2012-11-23 18:44:50 -07:00
Eli Barzilay
cbfb1fdb37 A whole bunch of missing newlines at EOFs (and a few other spaceages). 2012-10-19 06:47:24 -04:00
Robby Findler
d96d920cf9 rename contract-blueboxes.rktd to blueboxes.rktd 2012-08-14 16:20:47 -05:00
Robby Findler
0c6734f782 Add the contents of the "blue boxes" in the docs to the upper-right
corner of the definitions window, based on the information that check
syntax computes

This commit contains two separate changes to make this work:

  - adding a new renderer, based on the text renderer, that
    pulls out the contents of the blue boxes and saves them
    in the doc/ directories (specifically in the files named
    contract-blueboxes.rktd)

  - extend check syntax to use and display the information
    build by the new renderer
2012-08-12 08:41:46 -05:00
Matthew Flatt
f9b4c6b226 scribble: add --dest-base flag
Also add the option to `render' from `racket/render', and
document the existing `render%' initialization argument.
2012-07-06 16:48:36 -06:00
Matthew Flatt
3885f4683b add missing `render%' init argument doc 2011-11-02 08:12:58 -06:00
Matthew Flatt
932ef94cb3 fix contract 2011-10-28 06:43:20 -06:00
Matthew Flatt
e7ec9f5eb7 document `scribble/pdf-render; 2011-09-01 07:14:03 -06:00
Matthew Flatt
853e47f05e fix broken-link reporting by `scribble' 2011-08-22 07:58:05 -06:00
Matthew Flatt
39edc5a599 `scribble' reports broken cross references by default 2011-08-18 13:05:37 -06:00
Eli Barzilay
d61eb53686 Lots of documentation formatting.
Started as fixing misindented definitions, then more indentations, then
a bunch of similar things (square brackets, huge spaces at end-of-lines,
etc).
2011-08-15 07:50:04 -04:00
Matthew Flatt
7977d1817e expose the scribble' command-line driver as racket/render' 2011-08-01 14:40:49 -06:00
Eli Barzilay
debd1f9f1e Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files.
(Some other minor things here and there.)
2011-06-20 04:27:14 -04:00
Matthew Flatt
8b7c8d08bd add fix-point finding traverse pass to Scribble 2010-05-21 19:40:33 -06:00
Matthew Flatt
ce21cf9fd8 rackety slideshow doc 2010-05-02 12:19:25 -06:00
Matthew Flatt
fb4af54436 rackety Scribble doc 2010-05-02 12:00:44 -06:00
Matthew Flatt
cb5c83c5a7 add custom-print to printable<%>; redirect printable<%> to writable and pretty-print to pretty-write in 'scheme' 2010-05-01 08:43:20 -06:00
Matthew Flatt
413c90c0dc fix single-html scribble builds by planet; fix up teachpack docs; add Dave to acks; add a #:use-sources in errortrace docs
svn: r10139
2008-06-05 00:21:36 +00:00
Matthew Flatt
931d93ba2f Scribble support for redirecting external links and re-rooting corss-reference paths
svn: r9448
2008-04-24 02:37:47 +00:00
John Clements
5d9e8d8a3c changed contracts on src args for render methods
svn: r9113
2008-03-29 21:36:51 +00:00
John Clements
56b46aab9a fixed typo
svn: r9112
2008-03-29 20:47:24 +00:00
Matthew Flatt
cec8fbbd5f @require[....]* to @(require ...*)
svn: r8269
2008-01-09 13:47:11 +00:00
Matthew Flatt
bfecd9e0f5 doc scribble/xref, and start net docs
svn: r8021
2007-12-15 23:36:23 +00:00
Matthew Flatt
cd7157641c Scribble improvements: defmodule & co.
svn: r7902
2007-12-05 21:41:07 +00:00
Matthew Flatt
39cedb62ed v3.99.0.2
svn: r7706
2007-11-13 12:40:00 +00:00
Matthew Flatt
7e085ae75f save define-class-doc approach before trying to get rid of a lyer of bindings
svn: r7281
2007-09-05 14:18:44 +00:00
Matthew Flatt
e4cbc4e6a9 371.2
svn: r7263
2007-09-02 17:39:32 +00:00
Matthew Flatt
040031fd66 repairs to doc build
svn: r6251
2007-05-24 02:44:01 +00:00
Matthew Flatt
858c8024ef new documentation source moved to the trunk collects
svn: r6249
2007-05-24 02:20:28 +00:00