Wie generiere ich eine PDF-Dokumentation für LLVM?

995
Kuba Ober

LLVM wird mit HTML-Dokumentation geliefert, es sind keine PDF-Dateien zum Herunterladen verfügbar. Gibt es eine Möglichkeit, eine PDF-Dokumentation dafür zu erstellen?

2

2 Antworten auf die Frage

2
Kuba Ober

LLVM verwendet Sphinx zur Erstellung der Dokumentation, und Sphinx unterstützt die Generierung von PDF-Dokumentation über Latexpdf. Angenommen, Sie haben sowohl Sphinx als auch Latex installiert. Auf einem Unix-System benötigen Sie lediglich einen kleinen Patch für die generierte Latex-Datei, um die eifrige Verwendung einiger Unicode-Zeichen zu umgehen, die nicht standardmäßig vom inputenc-Paket unterstützt werden.

Eine vollständige Prozedur könnte folgendermaßen aussehen:

#! /bin/bash svn co http://llvm.org/svn/llvm-project/llvm/branches/release_34/docs llvm34-doc cd llvm34-doc make -f Makefile.sphinx latex patch -p0 <<ZZZ --- _build/latex/LLVM.tex 2013-12-08 17:54:29.000000000 -0500 +++ _build/latex/LLVM.tex 2013-12-08 17:54:08.000000000 -0500 @@ -3,6 +3,13 @@ \documentclass[letterpaper,10pt,english] \usepackage[utf8] \DeclareUnicodeCharacter{\nobreakspace} +\usepackage +\DeclareUnicodeCharacter{$\leq$} +\DeclareUnicodeCharacter{$\geq$} +\DeclareUnicodeCharacter{$\neq$} +\DeclareUnicodeCharacter{$\Rightarrow$} +\DeclareUnicodeCharacter{\ding} +\DeclareUnicodeCharacter{\ding} \usepackage[T1] \usepackage \usepackage ZZZ cd _build/latex make cd ../.. 

Beachten Sie, dass die Dokumentation für die PDF-Ausgabe nicht wirklich getestet / gepflegt wurde. Daher gibt es hier und da ein paar Störungen. Die Ausgabe ist 820 Seiten lang.

1
MariusMatutiae

Es ist sehr leicht. Laden Sie eine App für Ihren Browser herunter, z. B. Web2PDFfür Chrome (es gibt viele solcher Apps, die Sie im Chrome WebStore finden können, einfach google für Ihren Browser), und die gewünschte Webseite wird in ein PDF-Format konvertiert.

Wenn Sie ein CLI-Tool bevorzugen, ist wkhtmltopdf ein sehr schönes Instrument.

Außer, dass es sich um eine Momentaufnahme eines Hypertext-Dokuments handelt, das für das Web gestaltet wurde. Ich glaube nicht, dass Sphinx Stylesheets (und Inhalte!) Enthält, die auf Papier angemessen dargestellt werden. Beispielsweise fehlt das Inhaltsverzeichnis. Was Sie vorschlagen, ist natürlich eine gültige Lösung, wenn Latex nicht verfügbar ist. Kuba Ober vor 10 Jahren 1