Re: [PATCH 2/2] Add PDF output

2018-05-16 Thread Rob Herring 
On Mon, May 14, 2018 at 6:34 PM, Grant Likely  wrote:
> Use Sphinx-doc to generate PDF output from the source text.  With Sphinx
> installed, a PDF version of the document can be generated by typing:
> 'make latexpdf'
>
> Signed-off-by: Grant Likely 
> ---
>  .gitignore  |   1 +
>  Makefile|  20 +++
>  README.rst  |  56 +++
>  source/conf.py  | 163 
> 
>  source/ebbr.rst |  22 ++--
>  5 files changed, 259 insertions(+), 3 deletions(-)
>  create mode 100644 .gitignore
>  create mode 100644 Makefile
>  create mode 100644 source/conf.py
>
> diff --git a/.gitignore b/.gitignore
> new file mode 100644
> index 000..796b96d
> --- /dev/null
> +++ b/.gitignore
> @@ -0,0 +1 @@
> +/build
> diff --git a/Makefile b/Makefile
> new file mode 100644
> index 000..91bb4be
> --- /dev/null
> +++ b/Makefile
> @@ -0,0 +1,20 @@
> +# Minimal makefile for Sphinx documentation

SPDX tags here and other new files?

> +#
> +
> +# You can set these variables from the command line.
> +SPHINXOPTS=
> +SPHINXBUILD   = sphinx-build
> +SPHINXPROJ= EBBR
> +SOURCEDIR = source
> +BUILDDIR  = build
> +
> +# Put it first so that "make" without argument is like "make help".
> +help:
> +   @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) 
> $(O)
> +
> +.PHONY: help Makefile
> +
> +# Catch-all target: route all unknown targets to Sphinx using the new
> +# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
> +%: Makefile
> +   @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
> \ No newline at end of file

^^^

> diff --git a/README.rst b/README.rst
> index 1babcf4..57fac8f 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -13,6 +13,62 @@ expected in September 2018. You can find the current draft 
> text in this
>  repository, but be aware that everything in the draft text is subject to
>  change before an official v1.0 release is published.
>
> +Build Instructions
> +==
> +
> +Requirements
> +
> +
> +* Sphinx version 1.5 or later: http://sphinx-doc.org/contents.html

Why? DT spec only needs 1.2.3 (or its documentation is out of date).

> +* LaTeX (and pdflatex, and various LaTeX packages)
> +
> +On Debian and Ubuntu
> +
> +::
> +
> +  # apt-get install python-sphinx texlive texlive-latex-extra 
> libalgorithm-diff-perl \
> +texlive-humanities texlive-generic-recommended 
> texlive-generic-extra
> +
> +If the version of python-sphinx installed is too old, then an additional

Specifically, this is not needed on ubuntu 17.10 and later.

> +new version can be installed with the Python package installer::
> +
> +  $ apt-get install python-pip
> +  $ pip install --user --upgrade Sphinx
> +  $ export SPHINXBUILD=~/.local/bin/sphinx-build
> +
> +Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then 
> follow Make commands below
> +
> +On Mac OS X
> +^^^
> +
> +* Install MacTeX_
> +* Install pip if you do not have it::
> +
> +  $ sudo easy_install pip
> +
> +* Install Sphinx::
> +
> +  $ pip install --user --upgrade Sphinx
> +
> +.. _MacTeX: http://tug.org/mactex
> +
> +Make Targets
> +
> +
> +To generate PDF::
> +
> +  $ make latexpdf
> +
> +To generate hierarchy of HTML pages::
> +
> +  $ make html
> +
> +To generate a single HTML page::
> +
> +  $ make singlehtml
> +
> +Output goes in `./build` subdirectory.
> +
>  License
>  ===
>
___
boot-architecture mailing list
boot-architecture@lists.linaro.org
https://lists.linaro.org/mailman/listinfo/boot-architecture

[PATCH 2/2] Add PDF output

2018-05-14 Thread Grant Likely 
Use Sphinx-doc to generate PDF output from the source text.  With Sphinx
installed, a PDF version of the document can be generated by typing:
'make latexpdf'

Signed-off-by: Grant Likely 
---
 .gitignore  |   1 +
 Makefile|  20 +++
 README.rst  |  56 +++
 source/conf.py  | 163 
 source/ebbr.rst |  22 ++--
 5 files changed, 259 insertions(+), 3 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 Makefile
 create mode 100644 source/conf.py

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000..796b96d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/Makefile b/Makefile
new file mode 100644
index 000..91bb4be
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS=
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ= EBBR
+SOURCEDIR = source
+BUILDDIR  = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+   @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+   @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/README.rst b/README.rst
index 1babcf4..57fac8f 100644
--- a/README.rst
+++ b/README.rst
@@ -13,6 +13,62 @@ expected in September 2018. You can find the current draft 
text in this
 repository, but be aware that everything in the draft text is subject to
 change before an official v1.0 release is published.
 
+Build Instructions
+==
+
+Requirements
+
+
+* Sphinx version 1.5 or later: http://sphinx-doc.org/contents.html
+* LaTeX (and pdflatex, and various LaTeX packages)
+
+On Debian and Ubuntu
+
+::
+
+  # apt-get install python-sphinx texlive texlive-latex-extra 
libalgorithm-diff-perl \
+texlive-humanities texlive-generic-recommended 
texlive-generic-extra
+
+If the version of python-sphinx installed is too old, then an additional
+new version can be installed with the Python package installer::
+
+  $ apt-get install python-pip
+  $ pip install --user --upgrade Sphinx
+  $ export SPHINXBUILD=~/.local/bin/sphinx-build
+
+Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then 
follow Make commands below
+
+On Mac OS X
+^^^
+
+* Install MacTeX_
+* Install pip if you do not have it::
+
+  $ sudo easy_install pip
+
+* Install Sphinx::
+
+  $ pip install --user --upgrade Sphinx
+
+.. _MacTeX: http://tug.org/mactex
+
+Make Targets
+
+
+To generate PDF::
+
+  $ make latexpdf
+
+To generate hierarchy of HTML pages::
+
+  $ make html
+
+To generate a single HTML page::
+
+  $ make singlehtml
+
+Output goes in `./build` subdirectory.
+
 License
 ===
 
diff --git a/source/conf.py b/source/conf.py
new file mode 100644
index 000..fd4267b
--- /dev/null
+++ b/source/conf.py
@@ -0,0 +1,163 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# EBBR specification build configuration file, created by
+# sphinx-quickstart on Thu May 10 18:49:38 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+import subprocess
+
+# -- General configuration 
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.todo',
+'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'ebbr'
+
+# General information about the project.
+project = 'Embedded Base Boot Requirements (EBBR) Specification'
+copyright = '2018 Arm, Ltd. and Contributors'
+author = 'Arm, Ltd. and Contributors'
+
+# The version info for the project you're documenting,