summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Makefile37
-rw-r--r--Documentation/conf.py103
2 files changed, 2 insertions, 138 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 4d08c932b4..ec1e1a4d35 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -4,49 +4,16 @@
# hacked together by Stefan Reinauer <stepan@openbios.org>
#
-PDFLATEX = pdflatex -t a4
BUILDDIR ?= _build
SPHINXOPTS ?= -j auto
export SPHINXOPTS
-FIGS=codeflow.pdf hypertransport.pdf
-
-all: sphinx corebootPortingGuide.pdf
-
-SVG2PDF=$(shell command -v svg2pdf)
-INKSCAPE=$(shell command -v inkscape)
-CONVERT=$(shell command -v convert)
-
-codeflow.pdf: codeflow.svg
-ifneq ($(strip $(SVG2PDF)),)
- svg2pdf $< $@
-else ifneq ($(strip $(INKSCAPE)),)
- inkscape $< --export-pdf=$@
-else ifneq ($(strip $(CONVERT)),)
- convert $< $@
-endif
-
-hypertransport.pdf: hypertransport.svg
-ifneq ($(strip $(SVG2PDF)),)
- svg2pdf $< $@
-else ifneq ($(strip $(INKSCAPE)),)
- inkscape $< --export-pdf=$@
-else ifneq ($(strip $(CONVERT)),)
- convert $< $@
-endif
+all: sphinx
$(BUILDDIR):
mkdir -p $(BUILDDIR)
-corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
- # 2 times to make sure we have a current toc.
- $(PDFLATEX) corebootBuildingGuide.tex
- $(PDFLATEX) corebootBuildingGuide.tex
-
-corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc
- $(PDFLATEX) corebootBuildingGuide.tex
-
sphinx: $(BUILDDIR)
$(MAKE) -f Makefile.sphinx html BUILDDIR="$(BUILDDIR)"
@@ -68,7 +35,7 @@ test:
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
help:
- @echo "all - Builds coreboot porting guide PDF (outdated)"
+ @echo "all - Builds all documentation targets"
@echo "sphinx - Builds html documentation in _build directory"
@echo "clean - Cleans intermediate files"
@echo "clean-sphinx - Removes sphinx output files"
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 6e2da1e8af..143e60d4ad 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -94,92 +94,6 @@ html_css_files = [
# Output file base name for HTML help builder.
htmlhelp_basename = 'corebootdoc'
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
-
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, 'coreboot.tex', u'coreboot Documentation',
- u'the coreboot project', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-#
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#
-# latex_appendices = []
-
-# If false, will not define \strong, \code, itleref, \crossref ... but only
-# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
-# packages.
-#
-# latex_keep_old_macro_names = True
-
-# If false, no module index is generated.
-#
-# latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'coreboot', u'coreboot Documentation',
- [author], 1)
-]
-
-# If true, show URL addresses after external links.
-#
-# man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'coreboot', u'coreboot Documentation',
- author, 'coreboot', 'One line description of project.',
- 'Miscellaneous'),
-]
-
enable_auto_toc_tree = True
class MyCommonMarkParser(CommonMarkParser):
@@ -189,23 +103,6 @@ class MyCommonMarkParser(CommonMarkParser):
n = nodes.literal(mdnode.literal, mdnode.literal)
self.current_node.append(n)
-# Documents to append as an appendix to all manuals.
-#
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-#
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#
-# texinfo_no_detailmenu = False
-
-
def setup(app):
from recommonmark.transform import AutoStructify
# Load recommonmark on old Sphinx