ben
d51825b95e
example usage of 'other-doc'
2016-01-25 11:51:31 -05:00
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
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
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
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
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
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
6b8490b78b
scribble/sigplan: add to-appear
2015-11-23 12:22:31 -07: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:contract
s
...
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
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
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
4e96e99344
docs: clarify (under)specification of nested
default style
2015-05-28 16:22:57 -06:00
Alexis King
d895edf530
Fix typo in scriblib conditional content docs
2015-05-13 03:09:39 -07: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
Robby Findler
c84c1cf6cc
document typeset-code
...
also adjust contract on context-expr to admit that #f is allowed
2015-05-11 08:04:40 -05:00
Matthew Flatt
ea6de4535d
fix terminilogy: "Scribble" vs. "@-form"
2015-04-28 10:12:11 -06:00
Robby Findler
3ea5bd2e31
add some missing docs and @history annotations from commits e6630f0e9
and 39e0f6aec
2015-04-17 05:47:28 -05:00
Robby Findler
39e0f6aecd
add some tag predicates and tag manipulation functions
2015-04-15 03:39:32 -05:00
Robby Findler
9b026739ed
refactor blueboxes support code to avoid dependency on racket-index pkg
2015-04-12 16:34:32 -05:00
Matthew Flatt
74d3c5fa99
minor layout and prose style adjustments
2015-03-26 13:36:29 -06:00
Matthew Flatt
4a52d3c57c
racketblock: add "#i" to an inexact number to match source span
...
This heuristic could go slightly wrong, for example causing "10.000"
to render as "#i10.0" instead of "10.0", but it won't affect cases
where the output already matched the input.
2015-02-21 14:12:38 -07:00
Matthew Flatt
6556e9f92a
add x-source-pkg
to HTML output
2015-02-15 10:26:43 -07:00
Matthew Flatt
7d69325ada
fix overview documentation for scribble/eval
2014-12-29 16:32:52 -07:00
Matthew Flatt
22b0da4cd5
docs: modernize typesetting of "Getting Started with Documentation"
...
Use `codeblock` instead of `verbatim`.
2014-12-29 16:23:43 -07:00
Asumu Takikawa
b65585a126
Add an example showing how to cite a page/section
2014-12-16 16:58:25 -05:00
Matthew Flatt
c388f23424
fixup for previous commit
2014-12-15 18:11:08 -07:00
Matthew Flatt
f9622dabf3
add scribble/lp2
...
Unlike `scribble/lp` a programm written with `scribble/lp2` can be used
directly, due to its `doc` submodule.
2014-12-15 18:05:14 -07:00
Asumu Takikawa
6d43de50ef
Change link to scribble doc sources
...
The doc sources now live on Github post-split
rather than on the PLT git server.
2014-12-10 22:53:34 -05:00
Sam Tobin-Hochstadt
a316fc12c0
Remove extra directories.
2014-12-02 00:54:52 -05:00