• Paul Beesley's avatar
    doc: Add minimal Sphinx support · 653279b0
    Paul Beesley authored
    
    Add the essentials for supporting a Sphinx documentation build:
    
    - A makefile under docs/ to invoke Sphinx with the desired output
      format
    - A Sphinx master configuration file (conf.py)
    - A single, top-level index page (index.rst)
    - The TF.org logo that is integrated in the the sidebar of the
      rendered output
    
    Change-Id: I85e67e939658638337ca7972936a354878083a25
    Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    653279b0
Makefile 716 Bytes
#
# Copyright (c) 2019, ARM Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
SPHINXPROJ    = TrustedFirmware-A
SOURCEDIR     = .
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)