diff options
author | Pepijn de Vos <pepijndevos@gmail.com> | 2012-07-16 10:17:38 -0400 |
---|---|---|
committer | Pepijn de Vos <pepijndevos@gmail.com> | 2012-07-16 10:17:38 -0400 |
commit | 0b620cedec8b0fd3debf9788ab24386cc88cbaef (patch) | |
tree | b6aa62ce0ad9a46c379ea072c91510a53192c6f3 /pygments/formatters/html.py | |
parent | d86115879e19c7611dd324c3356e9af4adeb0016 (diff) | |
download | pygments-0b620cedec8b0fd3debf9788ab24386cc88cbaef.tar.gz |
update documentation to reflect urlformat change
Diffstat (limited to 'pygments/formatters/html.py')
-rw-r--r-- | pygments/formatters/html.py | 15 |
1 files changed, 4 insertions, 11 deletions
diff --git a/pygments/formatters/html.py b/pygments/formatters/html.py index 27b47708..27db0e8e 100644 --- a/pygments/formatters/html.py +++ b/pygments/formatters/html.py @@ -300,17 +300,10 @@ class HtmlFormatter(Formatter): link to their definitions. `lineanchors` should be used, and the tags file should specify line numbers(see the `-n` option to ctags) - `singlepage` - Defaults to True. Determines if links to name definitions should - link to other files. - - 'urlformat` - The URL to the root of your project, where the tag file resides. - This is prepended to links if `singlepage` is false. - - `linkfext` - Similar to `urlformat`, but sets the file extension used. - Defaults to .html + `urlformat` + A `String.format` pattern used to generate links to ctags definitions. + Avaliabe variable are `{path}`, `{fname}` and `{fext}`. + Defaults to an empty string, resulting in just `#prefix-number` links. **Subclassing the HTML formatter** |