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 grant.likely@arm.com --- .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 0000000..796b96d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/build diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..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 0000000..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, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +try: + version = str(subprocess.check_output(["git", "describe", "--dirty"]), 'utf-8').strip() +except: + version = "unknown-rev" +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'EBBRdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + 'papersize': 'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Release numbers with a qualifier (ex. '-rc', '-pre') get a watermark. +if '-' in release: + latex_elements['preamble'] = '\usepackage{draftwatermark}\SetWatermarkScale{.45}\SetWatermarkText{%s}' % (release) + +# 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, 'EBBR.tex', project, author, 'manual'), +] + + +# -- 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, 'ebbr', project, [author], 1) +] + + +# -- 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, 'EBBR', project, author, 'EBBR', + 'One line description of project.', 'Miscellaneous'), +] + + + diff --git a/source/ebbr.rst b/source/ebbr.rst index be51f90..414e3af 100644 --- a/source/ebbr.rst +++ b/source/ebbr.rst @@ -2,8 +2,24 @@ Copyright Arm Ltd. 2018 SPDX-License-Identifier: CC-BY-SA-4.0
+#################################################### +Embedded Base Boot Requirements (EBBR) Specification +#################################################### + +Copyright © 2017-2018 Arm Ltd and Contributors. + +This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 +International License. To view a copy of this license, visit +http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to +Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. + +.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png + :target: http://creativecommons.org/licenses/by-sa/4.0/ + :alt: Creative Commons License + :align: right + ******************* -ABOUT THIS DOCUMENT +About This Document *******************
Introduction @@ -439,7 +455,7 @@ APPENDIX D - Optional UEFI Protocols *******************************************
Basic Networking Support -==================== +========================
============================================ ====== Service UEFI § @@ -453,7 +469,7 @@ EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL 25.1 networking.
Network Boot Protocols -==================== +======================
========================================== ====== Service UEFI §