summaryrefslogtreecommitdiff
path: root/scripts/asciidoc2html.py
diff options
context:
space:
mode:
authorPhilipp Hansch <dev@phansch.net>2017-05-29 21:14:01 +0200
committerPhilipp Hansch <dev@phansch.net>2017-05-29 21:14:01 +0200
commitabd3333b9f88880ecdafb72cd4a0af15d910f85e (patch)
treec41f71de9a33ac56fc0355075dfb68e5a7486d5f /scripts/asciidoc2html.py
parenta48ea597d021686d94fe06b71e5a28eba9dd0049 (diff)
downloadqutebrowser-abd3333b9f88880ecdafb72cd4a0af15d910f85e.tar.gz
qutebrowser-abd3333b9f88880ecdafb72cd4a0af15d910f85e.zip
Add TOC to installation instructions
This adds a Table of Contents to the installation instructions to improve the navigation within the document. I decided to use the command line to configure the TOC because there were problems with using just using an attribute entry in the document header. Specifically the insertion of the `header.asciidoc` into the resulting HTML file prevented the attribute entry approach from working. The TOC can now be inserted into any doc file using toc::[]
Diffstat (limited to 'scripts/asciidoc2html.py')
-rwxr-xr-xscripts/asciidoc2html.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/asciidoc2html.py b/scripts/asciidoc2html.py
index cfdc1b8d5..0e51dac10 100755
--- a/scripts/asciidoc2html.py
+++ b/scripts/asciidoc2html.py
@@ -184,7 +184,7 @@ class AsciiDoc:
with open(modified_src, 'w+', encoding='utf-8') as final_version:
final_version.write(title + "\n\n" + header + current_lines)
- self.call(modified_src, dst, '--theme=qute')
+ self.call(modified_src, dst, '--theme=qute', '-a toc', '-a toc-placement=manual')
def _build_website(self):
"""Prepare and build the website."""