diff options
author | Jonathan Corbet <corbet@lwn.net> | 2016-03-06 20:29:31 -0700 |
---|---|---|
committer | Jani Nikula <jani.nikula@intel.com> | 2016-05-30 13:38:53 +0300 |
commit | 89a66d76109935aad387a5058f120aeb8246ae40 (patch) | |
tree | 256f6bd0d8f5b56ad2fbf87da4625e2a625335e8 /Documentation/sphinx/convert_template.sed | |
parent | c13ce448c8532965eb4e1115e78cb5b8ff8261a3 (diff) |
sphinx: cheesy script to convert .tmpl files
This script uses pandoc to convert existing DocBook template files to RST
templates. A couple of sed scripts are need to massage things both before
and after the conversion, but the result is then usable with no hand
editing.
[Jani: Change usage to tmplcvt <in> <out>. Fix escaping for docproc
directives. Add support the new kernel-doc extension.]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Diffstat (limited to 'Documentation/sphinx/convert_template.sed')
-rw-r--r-- | Documentation/sphinx/convert_template.sed | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/sphinx/convert_template.sed b/Documentation/sphinx/convert_template.sed new file mode 100644 index 000000000000..d53bb8220a26 --- /dev/null +++ b/Documentation/sphinx/convert_template.sed @@ -0,0 +1,14 @@ +# +# Pandoc doesn't grok <function> or <structname>, so convert them +# ahead of time. +# +# Use "$bq" instead of "`" so that pandoc won't mess with it. +# +s%<function>\([^<(]\+\)()</function>%:c:func:$bq\1$bq%g +s%<function>\([^<(]\+\)</function>%:c:func:$bq\1$bq%g +s%<structname>struct *\([^<]\+\)</structname>%:ref:$bqstruct \1$bq%g +s%<structname>\([^<]\+\)</structname>%:ref:$bqstruct \1$bq%g +# +# Wrap docproc directives in para and code blocks. +# +s%^\(!.*\)$%<para><code>DOCPROC: \1</code></para>% |