4 Scribbling Documentation

► |  | Scribble: Racket Documentation Tool

1 | Getting Started
2 | @ Syntax
3 | High-Level Scribble API
4 | Scribbling Documentation
5 | Literate Programming
6 | Text Preprocessing
7 | Low-Level Scribble API
| Index

▼ | 4 | Scribbling Documentation

4.1 | Getting Started with Documentation
4.2 | Style Guide
4.3 | Manual Forms
4.4 | Racket
4.5 | Evaluation and Examples
4.6 | In-Source Documentation
4.7 | BNF Grammars
4.8 | Compatibility Libraries

Version: 5.0.1.5
top← prev up next →

### 4`` Scribbling Documentation

The scribble/manual language and associated libraries provide extensive support for documenting Racket libraries. The most significant aspect of support for documentation is the way that source-code bindings are connected to documentation sites through the module namespace – a connection that is facilitated by the fact that Scribble documents are themselves modules that reside in the same namespace. Getting Started with Documentation provides an introduction to using Scribble for documentation, and the remaining sections document the relevant libraries and APIs in detail.

4.1 Getting Started with Documentation
4.1.1 Setting Up Library Documentation
4.1.2 Racket Typesetting and Hyperlinks
4.1.3 Section Hyperlinks
4.1.4 Defining Racket Bindings
4.1.5 Showing Racket Examples
4.1.6 Multi-Page Sections
4.2 Style Guide
4.2.1 Prose and Terminology
4.2.2 Typesetting Code
4.2.3 Typesetting Prose
4.2.4 Section Titles
4.2.5 Indexing
4.2.6 Examples
4.3 Manual Forms
4.3.1 Typesetting Code
4.3.1.1 Typesetting Comments
4.3.2 Documenting Modules
4.3.3 Documenting Forms, Functions, Structure Types, and Values
4.3.4 Documenting Classes and Interfaces
4.3.5 Documenting Signatures
4.3.6 Various String Forms
4.3.7 Links
4.3.8 Indexing
4.3.9 Images
4.3.10 Bibliography
4.3.11 Miscellaneous
4.3.12 Index-Entry Descriptions
4.4 Racket
4.5 Evaluation and Examples
4.6 In-Source Documentation
4.6.1 Source Annotations for Documentation
4.6.2 Extracting Documentation from Source
4.7 BNF Grammars
4.8 Compatibility Libraries
4.8.1 Compatibility Structures And Processing
4.8.2 Compatibility Basic Functions

top← prev up next →