← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-docutils/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/ref/rst/directives.txt

  • Committer: Package Import Robot
  • Author(s): Michael Schutte, Jakub Wilk, Michael Schutte, Dmitry Shachnev
  • Date: 2013-08-05 16:47:43 UTC
  • mfrom: (11.1.9 experimental)
  • Revision ID: package-import@ubuntu.com-20130805164743-00lyz2imgs85ttwz
Tags: 0.11-1
http://bugs.debian.org/712284
http://bugs.debian.org/714880
http://bugs.debian.org/714319
http://bugs.debian.org/714317
http://bugs.debian.org/685509
[ Jakub Wilk ]
* Remove martin f. krafft and Ben Finney from Uploaders at their requests.

[ Michael Schutte ]
* New upstream release 0.11, closes: #712284, #714880.
  - Drop patch math-output-html.diff: Fixed upstream.
  - Drop patch fix-buildhtml-progress.diff: Applied upstream.
  - Drop patch strict-csv-parser.diff: Fixed upstream.
  - Drop patch unknown-url-exc-use-repr.diff: Applied upstream.
  - Update patch move-data-to-usr-share.diff: Default stylesheet paths for
    writers/html4css1 have changed.
  - Refresh the remaining patches.
  - New patch no-local-roman.diff: Use the roman module from python-roman
    instead of the copy shipped with docutils.
  - Update information about upstream version control in debian/copyright.
* Change my e-mail host in Uploaders and debian/copyright to @debian.org.
* New patch rst2odt_prepstyles-elementtree.diff: Port the rst2odt_prepstyles
  utility to ElementTree.  Drop Recommends: python-lxml.  Closes: #714319.
* New patch odt-writer-ascii-filenames.diff: Only use ASCII for filenames of
  images embedded in ODT files, closes: #714317.

[ Dmitry Shachnev ]
* Use dh_python2 instead of deprecated dh_pysupport.
* Add XS-Testsuite header, and replace XS-Python-Version with preferred
  X-Python-Version (closes: #685509).
* Add myself to Uploaders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/ref/rst/directives.txt
3
3
=============================
4
4
:Author: David Goodger
5
5
:Contact: docutils-develop@lists.sourceforge.net
6
 
:Revision: $Revision: 7535 $
7
 
:Date: $Date: 2012-10-25 14:01:12 +0200 (Do, 25. Okt 2012) $
 
6
:Revision: $Revision: 7643 $
 
7
:Date: $Date: 2013-03-27 17:54:05 +0100 (Wed, 27 Mar 2013) $
8
8
:Copyright: This document has been placed in the public domain.
9
9
 
10
10
.. contents::
484
484
The "code" directive constructs a literal block. If the code language is
485
485
specified, the content is parsed by the Pygments_ syntax highlighter and
486
486
tokens are stored in nested `inline elements`_ with class arguments
487
 
according to their syntactic category. The actual highlighting can be
488
 
customized with a style-sheet (e.g. one `generated by Pygments`__).
 
487
according to their syntactic category. The actual highlighting requires
 
488
a style-sheet (e.g. one `generated by Pygments`__, see the
 
489
`sandbox/stylesheets`_ for examples).
489
490
 
490
491
The parsing can be turned off with the syntax_highlight_ configuration
491
492
setting and command line option or by specifying the language as `:class:`_
493
494
when Pygments_ is not installed or the language is not in the
494
495
`supported languages and markup formats`_.
495
496
 
496
 
__   http://pygments.org/docs/cmdline/#generating-styles
 
497
For inline code, use the `"code" role`_.
 
498
 
 
499
__ http://pygments.org/docs/cmdline/#generating-styles
 
500
__ http://docutils.sourceforge.net/sandbox/stylesheets/
497
501
.. _Pygments: http://pygments.org/
498
502
.. _syntax_highlight: ../../user/config.html#syntax-highlight
499
503
.. _supported languages and markup formats: http://pygments.org/languages/
 
504
.. _"code" role: roles.html#code
500
505
 
501
506
 
502
507
The following options are recognized:
1076
1081
 
1077
1082
   Thus, you may soon find Docutils' abilities to be insufficient for
1078
1083
   these purposes.  At that time, you should consider using a
1079
 
   templating system (like ht2html_) rather than the "header" and
 
1084
   documentation generator like Sphinx_ rather than the "header" and
1080
1085
   "footer" directives.
1081
1086
 
1082
 
   .. _ht2html: http://ht2html.sourceforge.net/
 
1087
   .. _Sphinx: http://sphinx-doc.org/
1083
1088
 
1084
1089
In addition to the use of these directives to populate header and
1085
1090
footer content, content may also be added automatically by the