summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeremy Kerr <jk@ozlabs.org>2016-05-05 12:24:23 +0800
committerJeremy Kerr <jk@ozlabs.org>2016-05-05 15:08:23 +0800
commita72974312446174f382ab424460f3b355fc2874c (patch)
treeda25d1b0c1731b7e2ee17cafc1a78c7b922b1617
parent235ccfc123806b736a50cc90838e634737c3842d (diff)
downloadopenbmc-docs-a72974312446174f382ab424460f3b355fc2874c.tar.gz
openbmc-docs-a72974312446174f382ab424460f3b355fc2874c.zip
Add infrastructure for User Guide
This change adds a little infrastructure for creating an OpenBMC User's Guide, from the user-related documents in markdown. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
-rw-r--r--Makefile18
-rw-r--r--userguide/userguide.tex30
2 files changed, 48 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..82ec1c3
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,18 @@
+
+# we need xelatex for utf-8 support
+tex = xelatex
+
+all: userguide.pdf
+
+.PHONY: all clean
+
+userguide.pdf: userguide/userguide.tex
+ $(tex) $^
+
+userguide/userguide.tex: rest-api.tex host-management.tex console.tex code-update.tex
+
+%.tex: %.md
+ pandoc -o $@ $^
+
+clean:
+ rm -f *.aux *.tex *.out *.pdf
diff --git a/userguide/userguide.tex b/userguide/userguide.tex
new file mode 100644
index 0000000..5c7287c
--- /dev/null
+++ b/userguide/userguide.tex
@@ -0,0 +1,30 @@
+\documentclass[]{article}
+
+% fonts: libertine for roman text, inconsolata for monospace
+\usepackage{fontspec}
+\setmainfont{Linux Libertine O}
+\setmonofont{Inconsolata}
+
+% page layout: full page, no paragraph indent
+\usepackage{fullpage}
+\usepackage{parskip}
+
+% document metadata
+\usepackage{hyperref}
+\hypersetup{
+ pdftitle={OpenBMC User’s Guide},
+ colorlinks=true,
+ urlcolor=blue
+}
+
+\begin{document}
+
+\title{OpenBMC User's Guide}
+\maketitle
+
+\input{rest-api}
+\input{host-management}
+\input{console}
+\input{code-update}
+
+\end{document}
OpenPOWER on IntegriCloud