Commit Graph

1819 Commits

Author SHA1 Message Date
Matthew Flatt
798155c4f9 add make-numberer to generalize section numbering 2016-01-09 20:21:18 -07:00
Spencer Florence
2881ef290d Allow for manipulating scribble.tex imports 2016-01-09 11:48:21 -06:00
Matthew Flatt
1db48e6fc6 fix test to allow a doc submodule 2016-01-01 14:36:09 -07:00
Matthew Flatt
0f0d662b14 scribble/lp2: strip code:comment, etc. 2015-12-30 07:22:15 -06:00
Matthew Flatt
bbbd68b3c2 declare-exporting: allow escaped module-path expressions 2015-12-30 06:54:51 -06:00
Matthew Flatt
f09604f097 scribble/lp2: declare doc submodule with module*
Using `module*` allows the documentation submodule to refer to the
implementation module.
2015-12-30 06:24:17 -06:00
Matthew Flatt
668e3799bd HTML output: refine handling of a table in a bullet
Avoid a blank bullet line when an item start with a "boxed"
table for `defform` and similar.
2015-12-21 15:35:34 -07:00
Vincent St-Amour
63f8793e78 Move scriblib docs to the "Scribble Libraries" category. 2015-12-19 18:03:37 -06:00
Matthew Flatt
d2bf2e49c5 move scribble/examples to scribble/example
Use singular to follow the naming convention of the style guide.
2015-12-18 06:28:27 -07:00
Robby Findler
a64dc617f8 bump version number so there is a version that's post the existence of
the scribble/examples library (version 1.14 came with the
eval logging change but at the time there was no scribble/examples
library)
2015-12-17 22:05:21 -06:00
Matthew Flatt
90455e2d6a add tests for examples 2015-12-13 09:09:33 -07:00
Matthew Flatt
ad9a465ab1 Latex: 'inset style renders through a SInsetFlow environment 2015-12-13 07:40:26 -07:00
Matthew Flatt
141d818675 adjust tests for change to examples label typesetting
There's now a blank line between "Examples:" and the example
interaction.
2015-12-12 16:50:46 -07:00
Matthew Flatt
50f835c4f1 add scribble/examples
The `scribble/examples` library provides a cleaner and more modern
interface for evaluation compared to `scribble/eval`.
2015-12-11 11:54:07 -07:00
Matthew Flatt
f1f47c5f16 scribble/examples: revert logging change, add options
The error-logging change in 81aeab1687 didn't work well for me
in further experiments. Change `interactions`, etc., to have a
`#:no-errors?` argument, instead. Also, add `eval:no-prompt`,
which provides an alternative to `def+int`.

Improve the documentaiton by correcting mistakes and filling
in some missing exports.
2015-12-11 10:03:31 -07:00
Matthew Flatt
0bd9a0d070 examples: add "Examples:" label as compound para
Instead of creating a table to combine "Examples:" with the exmaple
content, use a compound paragraph (which didn't exist when `examples`
was first implemented). A compound paragraph provides better and more
consistent typesetting; for example, it doesn't make the word
"Examples:" use a fixed-width font in HTML output.
2015-12-10 09:24:34 -07:00
Matthew Flatt
81aeab1687 scribble/eval: add eval:error and logging of other exceptions
When an expression in `examples` or `interactions` raises an
exception, the error message is rendered as part of the documentation.
Now, however, unless the expression is wrapped with `eval:error`, an
error is also logged.

Logging an error is a compromise between backward compatibility (for
documents that rely on undeclared but expected errors) and making a
document fail completely (which would be nicer when an error is not
expected).
2015-12-10 08:33:00 -07:00
Matthew Flatt
f637b94a61 evaluate expression only once for eval:check 2015-12-10 08:06:41 -07:00
Matthew Flatt
904f83ecf3 rely on syntax objects preserving source locations
Rely on the representation of source locations in syntax objects, so
that its marshaling can take care of problems with absolute paths.
2015-12-09 17:24:20 -07:00
Matthew Flatt
6b8490b78b scribble/sigplan: add to-appear 2015-11-23 12:22:31 -07:00
Matthew Flatt
efae6bd375 Latext rendered: support single-line box characters (light and heavy) 2015-11-08 07:32:58 -07:00
Robby Findler
e0bbdf62bf add support for alternative unicode for white square brackets
please include in 6.3
2015-10-18 07:57:28 -05:00
Matthew Flatt
5bd82177cb Latex rendering for not-in character 2015-10-17 12:18:52 -06:00
Vincent St-Amour
9c26539b71 Add missing history annotations.
Please merge to 6.3.
2015-10-12 14:41:11 -05:00
Matthew Flatt
296e55d0e0 correct docs on code:contract
Unfortunately, `scribble/manual` and `pict/code` differ on how they
color `code:contract` content.
2015-10-02 15:36:12 -06:00
Matthew Flatt
a2f430020a scribble/eval: strip away code:contracts
Make `code:contract` handled like `code:comment` for evaluation.

Relevant to PR 15161
2015-10-02 15:24:08 -06:00
Matthew Flatt
26eff4c03a fix racketblock docs on code:comment and code:contract 2015-10-02 15:24:08 -06:00
Alexis King
6b1a49f929 Fix typo in CLI help (speficic -> specific) 2015-10-02 11:32:40 -05:00
Vincent St-Amour
70844e237b Remove dependency on eli-tester.
Was causing dependency issues on the Debian package builds.
2015-09-26 21:49:01 -05:00
William J. Bowman
ea01ae2f68 Added example of @tech with #:doc
I never remember how to use this.
2015-09-17 11:14:09 -05:00
Leif Andersen
94804a1579 Fix types in sigplan documentation 2015-09-09 13:18:07 -04:00
AlexKnauth
5d15699944 link the #lang in codeblocks
This makes the codeblock form output a (hash-lang) element for the
#lang, which is consistent with racketblock
2015-09-07 11:08:27 -06:00
Alexis King
f33e8c0746 Fix eval:check in interaction to properly validate its arguments 2015-08-25 17:14:34 -05:00
Vincent St-Amour
1a6f1b593e Remove dependency on unstable/struct. 2015-08-19 14:18:53 -05:00
Matthew Flatt
e0a14fa28d tabular: fix insertion of separator before 'cont
Use 'cont before a 'cont cell instead of adding a separator.
2015-08-04 09:44:36 -06:00
Matthew Flatt
0ea9922784 fix doc typo 2015-07-30 14:54:48 -06:00
Vincent St-Amour
ea70707036 Merge unstable/sandbox with scribble/eval. 2015-07-23 15:04:44 -05:00
Matthew Flatt
8a490208c5 fix racketgrammar, etc., treatment of ... for new macro system
The `(let ([... _]) _)` trick to hide the binding of `...` no
longer works; explicitly strip the context of any `...`,
instead.
2015-07-16 08:40:04 -06:00
Matthew Flatt
76a1fdf04f fix scribble/text with syntax-local-identifier-as-binding 2015-07-16 08:40:04 -06:00
Matthew Flatt
6d440f5a6b fix more problems with a generated doc submodule
One problem involved context that should not be included in
a generated submodule, while another one was an issue with
the previous repair to the shift to label phase.
2015-07-16 08:40:04 -06:00
AlexKnauth
b1d380d4b5 convert blueboxes.rkt to typed racket 2015-07-11 09:53:54 -05:00
Matthew Flatt
b812869d3e drop 'aux elements from left-margin contents
Removing aux elements for the left-margin contexts makes link
rendering consistent with other hyperlinks.
2015-06-09 07:09:38 -06:00
Matthew Flatt
c1df897ab3 fix codeblock to use location only for current source 2015-06-09 07:09:11 -06:00
Matthew Flatt
2c45064376 scribble/jfp: work around a collision with mathabx 2015-05-28 16:23:16 -06:00
Matthew Flatt
4e96e99344 docs: clarify (under)specification of nested default style 2015-05-28 16:22:57 -06:00
Sam Tobin-Hochstadt
798179ed3a Merge pull request #5 from lexi-lambda/patch-1
Fix typo in scriblib conditional content docs
2015-05-13 10:59:28 -04:00
Alexis King
d895edf530 Fix typo in scriblib conditional content docs 2015-05-13 03:09:39 -07:00
Alex Suraci
e00eb753c3 markdown hyperlinks can now contain other content
e.g. [**foo** `bar` _baz_](http://example.com)
2015-05-12 09:33:45 -06:00
Alex Suraci
fc08b7ba49 refactor markdown renderer a bit
* favor recursion for wrapping text in markdown notation
* simplify params to just bool, use parameterize with recursion
2015-05-12 09:19:48 -06:00
Eli Barzilay
117218dc3e Two bugfixes.
* Fix contract on `with-writer`.

* The default writer is initially `write-string`, not `display`.
2015-05-11 16:44:44 -06:00