diff options
author | Sandrine Bailleux <sandrine.bailleux@arm.com> | 2019-11-27 11:27:13 +0000 |
---|---|---|
committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2019-11-27 11:27:13 +0000 |
commit | 6c81de700adcf68a9db9a3e6ae2c747d434d3dd9 (patch) | |
tree | 42f2cd4e5c79abf28278d2d0bdcdbc6cc1eff959 | |
parent | a78c8203e8ce7b901c13ae9fb25d8863c1bcd5bc (diff) | |
parent | 717bac4dca0bf204329a8cb19f52c8e30bb58502 (diff) | |
download | tf-a-tests-6c81de700adcf68a9db9a3e6ae2c747d434d3dd9.tar.gz |
Merge "doc: Add basic Sphinx configuration and Makefile"
-rw-r--r-- | docs/Makefile | 25 | ||||
-rw-r--r-- | docs/conf.py | 81 | ||||
-rw-r--r-- | docs/index.rst | 17 | ||||
-rw-r--r-- | docs/requirements.txt | 3 | ||||
-rw-r--r-- | docs/resources/TrustedFirmware-Logo_standard-white.png | bin | 0 -> 5826 bytes |
5 files changed, 126 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..a7083fb39 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,25 @@ +# +# 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 Tests +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) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..58f5e72ba --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- +# +# Copyright (c) 2019, Arm Limited. All rights reserved. +# +# SPDX-License-Identifier: BSD-3-Clause +# +# +# Configuration file for the Sphinx documentation builder. +# +# See the options documentation at http://www.sphinx-doc.org/en/master/config + +import os + +# -- Project information ----------------------------------------------------- + +project = 'Trusted Firmware-A Tests' + +# -- General configuration --------------------------------------------------- + +# 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.autosectionlabel', 'sphinxcontrib.plantuml'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# 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 pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# Minimum version of sphinx required +needs_sphinx = '2.0' + +# -- Options for HTML output ------------------------------------------------- + +# Don't show the "Built with Sphinx" footer +html_show_sphinx = False + +# Don't show copyright info in the footer (we have this content in the page) +html_show_copyright = False + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "sphinx_rtd_theme" + +# The logo to display in the sidebar +html_logo = 'resources/TrustedFirmware-Logo_standard-white.png' + +# Options for the "sphinx-rtd-theme" theme +html_theme_options = { + 'collapse_navigation': False, # Can expand and collapse sidebar entries + 'prev_next_buttons_location': 'both', # Top and bottom of the page + 'style_external_links': True # Display an icon next to external links +} + +# -- Options for autosectionlabel -------------------------------------------- + +# Only generate automatic section labels for document titles +autosectionlabel_maxdepth = 1 + +# -- Options for plantuml ---------------------------------------------------- + +plantuml_output_format = 'svg_img' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..8a326082c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +Trusted Firmware-A Tests Documentation +====================================== + +.. toctree:: + :maxdepth: 1 + :hidden: + + Home<self> + user-guide + porting-guide + implementing-tests + design + change-log + +-------------- + +*Copyright (c)2019, Arm Limited. All rights reserved.* diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..358ed0e3c --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx>=2.0.0 +sphinx-rtd-theme>=0.4.3 +sphinxcontrib-plantuml>=0.15 diff --git a/docs/resources/TrustedFirmware-Logo_standard-white.png b/docs/resources/TrustedFirmware-Logo_standard-white.png Binary files differnew file mode 100644 index 000000000..e7bff7128 --- /dev/null +++ b/docs/resources/TrustedFirmware-Logo_standard-white.png |