diff options
author | Karl Berry <karl@freefriends.org> | 2020-09-03 21:07:12 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-09-03 21:07:12 +0000 |
commit | 2460993119d8ffa82074d9f0c61b828dda39799b (patch) | |
tree | f1341cde2e628d4fc76ee015fc3bf4241c4c9be5 /Master/texmf-dist/doc/latex/docutils/README.md | |
parent | 24747f42d2ae33e72bd6cb817501a16951912000 (diff) |
docutils (3sep20)
git-svn-id: svn://tug.org/texlive/trunk@56252 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/docutils/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/docutils/README.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/docutils/README.md b/Master/texmf-dist/doc/latex/docutils/README.md new file mode 100644 index 00000000000..2a0cc3b195d --- /dev/null +++ b/Master/texmf-dist/doc/latex/docutils/README.md @@ -0,0 +1,69 @@ +docutils.sty +============ + +Helper commands and element definitions for Docutils_ LaTeX output. + +:Copyright: © 2020 Günter Milde + +:Licence: Released under the terms of the `2-Clause BSD license`__ + + __ https://opensource.org/licenses/BSD-2-Clause + + +Changelog +--------- + +| 2020-08-28 first public version for Docutils >= 0.17 + +Requirements +------------ + +None. + +Installation +------------ + +If possible, get this package from your distribution using its +installation manager. Alternatively, copy/move/link ``docutils.sty`` +to a place where LaTeX can find it. + +Usage +----- + +The package is intended for use with LaTeX documents generated from +reStructuredText_ sources with Docutils_. + +When generating LaTeX documents, specify this package with the +`"stylesheet"`_ `configuration option`_, e.g. :: + + rst2latex --stylesheet=docutils exampledocument.txt + +The the Docutils `LaTeX writer` will then reference this package +istead of inserting required definitions into the preamble of +generated documents (see the `Docutils LaTeX Writer documentation`_ +for details). + +.. _reStructuredText: https://en.wikipedia.org/wiki/ReStructuredText + +.. _Docutils: https://docutils.sourceforge.io/ + +.. _"stylesheet": + https://docutils.sourceforge.io/docs/user/config.html#stylesheet-latex-writers + +.. _configuration option: + https://docutils.sourceforge.io/docs/user/config.html + +.. _Docutils LaTeX Writer documentation: + https://docutils.sourceforge.io/docs/user/latex.html + +Documentation Generation +------------------------ + +The bidirectional text <-> code converter PyLit_ and Docutils_ +were used to generate the HTML documentation:: + + #> pylit docutils.sty + #> rst2html5 docutils.sty.txt docutils.sty.html + +.. _Pylit: https://repo.or.cz/pylit.git + |