diff options
author | Zhiming Wang <zmwangx@gmail.com> | 2016-12-13 19:21:30 -0500 |
---|---|---|
committer | wm4 <wm4@nowhere> | 2016-12-14 21:43:30 +0100 |
commit | 870a6a11d99d67e5fcf1a1cb28c3de3167494470 (patch) | |
tree | 194fc7cf12f84b67f09b73cfe9451de9ec884390 | |
parent | 544110bf430f34b75d86dd0ea416f8c5e5f9386d (diff) | |
download | mpv-870a6a11d99d67e5fcf1a1cb28c3de3167494470.tar.bz2 mpv-870a6a11d99d67e5fcf1a1cb28c3de3167494470.tar.xz |
manpage: add table of contents to the HTML version
The reST contents directive is added to mpv.rst.
In wscript_build.py, the --strip-elements-with-class=contents option is
needed for the rst2man call in order to prevent the TOC from appearing
in mpv.1.
-rw-r--r-- | DOCS/man/mpv.rst | 2 | ||||
-rw-r--r-- | wscript_build.py | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst index aa68bee896..7108306008 100644 --- a/DOCS/man/mpv.rst +++ b/DOCS/man/mpv.rst @@ -9,6 +9,8 @@ a media player :Manual section: 1 :Manual group: multimedia +.. contents:: Table of Contents + SYNOPSIS ======== diff --git a/wscript_build.py b/wscript_build.py index 461e971f66..b7c7b39464 100644 --- a/wscript_build.py +++ b/wscript_build.py @@ -28,7 +28,7 @@ def _build_man(ctx): name = 'rst2man', target = 'DOCS/man/mpv.1', source = 'DOCS/man/mpv.rst', - rule = '${RST2MAN} ${SRC} ${TGT}', + rule = '${RST2MAN} --strip-elements-with-class=contents ${SRC} ${TGT}', install_path = ctx.env.MANDIR + '/man1') _add_rst_manual_dependencies(ctx) |