Commit Graph

23 Commits

Author SHA1 Message Date
Matthew Flatt
d8f2cc1bd9 raco pkg create: support "source" and "binary" bundling
Adds `--from-dir' and `--from-install' flags to select the interpretation
of the argument as a directory or as the name of an installed package.
Relevant to PR 13669

Adds `--as-is' (the default), `--source', and `--binary' flags to
select a pruning mode.

The `raco setup' tool recognizes a `rendered-scribblings' specification
in "info.rkt" to trigger moving rendered documentation into place,
registering its tags in the cross-reference database, and fixing up
references to "local-redirect.js"; the presence of a "synced.rktd"
indicates when those fixups have been performed (since, if the package
is installed in a user-specific scope, the documentation doesn't actually
move anywhere). Finally, "out<n>.sxref" needs to report paths relative to
the documentation's directory, and then the relative-directory references
need to be suitably resolved at derserialization; some support for such
relative paths was in place, but it wasn't quite general enough before.

original commit: 198a65a5fc79649ec167d2407c35815768a119ba
2013-05-16 11:50:04 -06:00
Matthew Flatt
fff0344f4e render non-installaction-scoped package docs with an indirection
The indirection uses a "local-redirect.js" script to rewrite
the document links to local links within the browser. This mechanism
is a step towards distributing compiled packages that include
already-built documentation, where paths to other documentation
can be different than in the build environment.

If the links are not rewritten, they are queries to
"pkg-docs.racket-lang.org", with the idea tha such a server will exist
for reading all package documentation online. Also, a package's
documentation that refer to documentation for uninstalled packages,
in which case the corresponding links will not get rewritten and
will continue to point to the server.

Rendering the "local-redirect.js" script spends a lot of time just
converting among different path formats. Various library changes in
this commit are aimed at speed up those conversions, but the big
improvement came from a `path->url-string' that shortcuts conversion
os simple Unix paths.

original commit: 9361b1e709bc7a75822c7da68530cbe0fef4ae28
2013-05-08 09:54:30 -04:00
Matthew Flatt
34f12bcd59 scribble: preserve order of ".js", ".css", and ".tex" additions
original commit: 08604b027740e515d69b677d8542eb45fc8791b2
2013-02-18 11:14:31 -07:00
Matthew Flatt
d1fc7f41da scribble: improve HTML handling of 'unnumbered and 'toc-hidden
A part with style property 'toc-hidden no longer
hides child sections, which makes it consistent with Latex/PDF
rendering.

A part with style 'grouper and 'unnumbered does not make its
child parts render as more nested, which is consistent with
'gruper without 'unnumbered. An unnumbered grouper is represented
as "" in a section-number list (while #f is still used for
unnumbered non-grouper layers).

original commit: 23d0627acc36998dc76ebd840276c80f47cab459
2013-02-15 20:11:18 -07:00
Matthew Flatt
1c5b304b1b Scribble: add 'grouper and 'hidden-number part style properties
Also, clean up documentation and implementation of 'unnumbered and
'hidden.

original commit: c0c2eda628c5786c18d29a3071087e268bd76109
2013-02-01 10:15:53 -08:00
Matthew Flatt
b5865f2f79 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).

original commit: a73dc502242d5a61efe526ebb19fc2588f30372a
2012-11-23 18:44:51 -07:00
Matthew Flatt
280f5e966a 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%).

original commit: 8c1b5db81553b54b35e753441efd0465426707a3
2012-11-23 18:44:50 -07:00
Matthew Flatt
e15bf50937 scribble/html-properties: allow URLs in css-addition' and js-addition'
original commit: 3fb42cf3f1b49e1cdf024c32a8f969011c2be9b3
2012-09-11 18:52:59 -06:00
Robby Findler
c456ffef40 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

original commit: 0c6734f782867b0401db15eb687fd246552e17b5
2012-08-12 08:41:46 -05:00
Matthew Flatt
9650c4767b scribble/*-properties: allow literal bytes in *-additions
For example, a `tex-addition' structure can have literal bytes
to include in the generated Latex, instead of a path to a file that
holds the content.

original commit: 2b9f57b01d55a39a70f0d0df22bc97b1874727ea
2012-07-06 13:17:35 -06:00
Matthew Flatt
e151e32b82 change Scribble xref formats, so that HTML info works for Latex
There's no particular reason that any one format will have all
the information that other formats need, but it conveniently works
for now that HTML info can subsume Latex info.

original commit: a1fd742ed022035732b4a0c778168cc6b862933a
2012-01-11 16:39:52 -07:00
Matthew Flatt
ef02b4039c scribble: fix HTML rendering of table in nested flow starting item
original commit: 07342303e5eb63c0d255cacaa49faabc8c667d19
2011-12-03 08:41:15 -07:00
Matthew Flatt
201f279940 scribble: use Latex skull package only if needed
original commit: 93bcc58a0c348429a6fc145d83211d4e038f95e6
2011-11-26 09:01:46 -07:00
Matthew Flatt
5d67e0fe48 fix broken-link reporting by `scribble'
original commit: 853e47f05e6feaaa4d29662d2b5a2042a2bea30a
2011-08-22 07:58:05 -06:00
Eli Barzilay
45a9cd48c2 ".ss" -> ".rkt" scan done.
original commit: 3157955d40f89d83fb3d5fa7a2f20639cda69579
2011-07-02 10:37:53 -04:00
Matthew Flatt
e4f618d24d scribble: add support for setting a document date
in Latex output, and also document and generalize
 the 'pretitle paragraph style

original commit: 66178570b6f13fe2f6163d7b15e9e4118a4d0bad
2011-05-15 19:42:22 -06:00
Matthew Flatt
334060a553 fix temp file names when building PDFs of installed docs
Closes PR 11830

original commit: 192c56629434524ddc29a2f551094363cb8b7ab1
2011-04-14 12:40:18 -06:00
Matthew Flatt
befd85c2d8 Scribble: simplify content that is conditioned on the render mode
including a new `scriblib/render-cond' library

original commit: df2a875ff4aaff90b20906a80dff6218470eb455
2011-04-04 10:45:02 -06:00
Matthew Flatt
6fb5dc58de scribble: render `pict' content directly
--- actually, any value that is convertible to PNG/PDF

original commit: 0f86dc15afe6d0bf48a77f8aec7d66fda356082b
2010-11-26 20:40:43 -07:00
Kevin Tew
b665360e57 Fix cross references
original commit: 81c4275220e6d8eee2d4769353aba748b7d8d0a6
2010-07-24 23:06:43 -06:00
Kevin Tew
df74bf0d30 Parallel docs build
original commit: 5bb2e148de87457ebb4790287d3b83b872c91a78
2010-07-22 02:39:57 -06:00
Matthew Flatt
f15af6e90b add fix-point finding traverse pass to Scribble
original commit: 8b7c8d08bdaeed5f0ec42fc1a4855ad19e7354b2
2010-05-21 19:40:33 -06:00
Matthew Flatt
7e5406e889 rename all files .ss -> .rkt
original commit: 28b404307793f041bb3363135a2968e283855318
2010-04-27 16:50:15 -06:00