Doc: Add support for Sphinx documentation build.
Technical documentation of TF-M is captured in GitHub flavored
markdown files. This change add support for building HTML and
PDF output of these files using the Sphinx tool.
Change-Id: I8be11256f2c654c248b1974974a5de6190ca0fc3
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
diff --git a/docs/conf.py.in b/docs/conf.py.in
new file mode 100644
index 0000000..1caebb2
--- /dev/null
+++ b/docs/conf.py.in
@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#-------------------------------------------------------------------------------
+# Copyright (c) 2019, Arm Limited. All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+#-------------------------------------------------------------------------------#
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('..'))
+sys.path.insert(0, os.path.abspath('../docs'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'TF-M'
+copyright = '2017-2019, ARM CE-OSS'
+author = 'ARM CE-OSS'
+title = 'TF-M user Guide'
+
+# The short X.Y version
+version = '@SPHINXCFG_TFM_VERSION@'
+# The full version, including alpha/beta/rc tags
+release = '@SPHINXCFG_TFM_VERSION_FULL@'
+
+
+# -- 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.imgmath',
+ 'm2r',
+]
+
+# 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']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+#Disable adding conf.py copyright notice to HTML output
+html_show_copyright = False
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TF-M doc'
+
+
+# -- 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, 'TF-M.tex', title,
+ 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, 'tf-m', title,
+# [author], 7)
+#]
+
+
+# -- 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, 'TF-M', title,
+# author, 'TF-M', 'Trusted Firmware for Cortex-M',
+# 'Miscellaneous'),
+#]
+
+
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..f88134a
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,81 @@
+:Page authors: Gyorgy Szing <gyorgy.szing@arm.com>
+
+..
+ The build-system will copy all documents into a temporary directory tree
+ before the documentation is built.
+ This fill will be copied to the top level and thus please use relative paths
+ as if this file would be in <TFM_ROOT_DIR>.
+
+Welcome to TF-M's documentation!
+================================
+
+.. toctree::
+ :maxdepth: 2
+ :glob:
+ :hidden:
+
+ contributing.md
+ glossary.md
+ maintainers.md
+ docs/user_guides/tfm_sw_requirement.md
+ docs/user_guides/tfm_build_instruction.md
+ docs/coding_guide.md
+ docs/user_guides/tfm_user_guide.md
+ docs/user_guides/os_migration_guide_armv8m.md
+ docs/user_guides/tfm_integration_guide.md
+ docs/user_guides/tfm_ns_client_identification.md
+ docs/user_guides/tfm_secure_boot.md
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Secure services
+ :glob:
+ :hidden:
+
+ docs/user_guides/services/*
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Components
+ :glob:
+ :hidden:
+
+ lib/**
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Target platforms
+ :glob:
+ :hidden:
+
+ platform/**
+
+.. toctree::
+ :caption: Design documents
+ :maxdepth: 2
+ :glob:
+ :hidden:
+
+ docs/design_documents/*
+
+.. toctree::
+ :caption: Draft design documents
+ :maxdepth: 2
+ :glob:
+ :hidden:
+
+ docs/design_documents/drafts/*
+
+.. toctree::
+ :caption: Rejected design documents
+ :maxdepth: 2
+ :glob:
+ :hidden:
+
+ docs/design_documents/rejected/*
+
+.. mdinclude:: readme.md
+
+-----------
+
+:Copyright: Copyright (c) 2019, Arm Limited. All rights reserved.
diff --git a/docs/user_guides/tfm_build_instruction.md b/docs/user_guides/tfm_build_instruction.md
index 3e2d5f5..368557a 100644
--- a/docs/user_guides/tfm_build_instruction.md
+++ b/docs/user_guides/tfm_build_instruction.md
@@ -155,7 +155,27 @@
The documentation files will be available under the directory:
~~~
-<cmake_doc>/install/doc/reference_manual
+cmake_doc/install/doc/reference_manual
+~~~
+
+## Building the User Guide
+Please ensure the dependencies for building the firmware and the documentation
+are installed as explained in the [software requirements](tfm_sw_requirement.md).
+
+*Note* For building the documentation all tools needed to build the firmware
+must be available.
+
+~~~
+cd <TF-M base folder>
+mkdir cmake_doc
+cd cmake_doc
+cmake ../ -G"Unix Makefiles" -DTARGET_PLATFORM=AN521 -DCOMPILER=ARMCLANG
+cmake --build ./ -- install_userguide
+~~~
+
+The documentation files will be available under the directory:
+~~~
+cmake_doc/install/doc/user_guide
~~~
--------------
diff --git a/docs/user_guides/tfm_sw_requirement.md b/docs/user_guides/tfm_sw_requirement.md
index 8380ca6..d474770 100644
--- a/docs/user_guides/tfm_sw_requirement.md
+++ b/docs/user_guides/tfm_sw_requirement.md
@@ -73,11 +73,11 @@
CMake generators other than "Unix Makefiles" may work, but are not officially
supported.
-# Example setups
+## Example setups
This section lists dependencies and some exact and tested steps to set-up a
TF-M-m build environment under various OSes.
-## Ubuntu
+### Ubuntu
- DS-5 v5.27.1.
- Git tools v2.10.0
- CMake (see the "Supported CMake versions" chapter)
@@ -90,7 +90,7 @@
- sudo apt-get install python3-crypto python3-pyasn1 python3-yaml python3-jinja2
- SRecord v1.58 (for Musca test chip boards)
-### Setup a shell to enable compiler toolchain and CMake after installation.
+#### Setup a shell to enable compiler toolchain and CMake after installation.
To import Arm Compiler v6.7.1 in your bash shell console:
@@ -113,7 +113,7 @@
export PATH=<GNU_ARM_PATH>/bin:$PATH
~~~
-## Windows + Cygwin
+### Windows + Cygwin
- uVision v5.24.1 or DS-5 v5.27.1 (DS-5 Ultimate Edition) which provides the
Arm Compiler v6.7.1 compiler or GNU Arm compiler v6.3.1.
- Git client latest version (https://git-scm.com/download/win)
@@ -129,7 +129,7 @@
- Python3 pip
- [SRecord v1.63](https://sourceforge.net/projects/srecord/) (for Musca test chip boards)
-### Setup Cygwin to enable a compiler toolchain and CMake after installation.
+#### Setup Cygwin to enable a compiler toolchain and CMake after installation.
If applicable, import Arm Compiler v6.7.1 in your shell console. To make this
change permanent, add the command line into ~/.bashrc
@@ -179,7 +179,17 @@
export PATH=/cygdrive/c/<CMAKE_PATH>/bin:$PATH
~~~
-## To compile the TF-M Reference Manual
+### Building documentation
+The build system is prepared to support generation of two documents. The
+Reference Manual which is Doxygen based, and the User Guide which is Sphinx
+based.
+Both document can be generated in HTML and PDF format.
+
+*Note* support for document generation in the build environment is not
+mandatory. Missing document generation tools will not block building the TF-M
+firmware.
+
+#### To compile the TF-M Reference Manual
The following additional tools are needed:
- Doxygen v1.8.0 or later
- Graphviz dot v2.38.0 or later
@@ -190,20 +200,16 @@
- LaTeX
- PdfLaTeX
-*Note* support for document generation in the build environment is not
-mandatory. Missing document generation tools will not block building the TF-M
-firmware.
+##### Set-up the needed tools
-###Set-up the needed tools
-
-#### Linux
+###### Linux
- sudo apt-get install -y doxygen graphviz default-jre
- mkdir ~/plantuml; curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
For PDF generation:
- sudo apt-get install -y doxygen-latex
-#### Windows
+###### Windows
- [Doxygen 1.8.8](https://sourceforge.net/projects/doxygen/files/snapshots/doxygen-1.8-svn/windows/doxygenw20140924_1_8_8.zip/download)
- [Graphviz 2.38](https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi)
- The Java runtime is part of the DS5 installation or can be
@@ -217,14 +223,71 @@
installing missing LaTeX components. Please allow the MikTeX package manager to
set-up these.
-### Configure the shell
+###### Configure the shell
-#### Linux
+####### Linux
~~~
export PLANTUML_JAR_PATH="~/plantuml/plantuml.jar"
~~~
-#### Windows + Cygwin
+####### Windows + Cygwin
+Assumptions for the settings below:
+- plantuml.jar is available at c:\plantuml\plantuml.jar
+- doxygen, dot, and MikTeX binaries are available on the PATH.
+
+~~~
+export PLANTUML_JAR_PATH="c:/plantuml/plantuml.jar"
+export PATH=$PATH:/cygdrive/c/<DS-5 path>/sw/java/bin
+~~~
+
+#### To compile the TF-M User Guide
+The following additional tools are needed:
+- Python3 and the following modules:
+ - Sphinx v1.7.9
+ - m2r v0.2.0
+- Graphviz dot v2.38.0 or later
+- PlantUML v1.2018.11 or later
+- Java runtime environment 1.8 or later (for running PlantUML)
+
+For PDF generation the following tools are needed in addition to the above list:
+- LaTeX
+- PdfLaTeX
+
+##### Set-up the needed tools
+
+###### Linux
+- sudo apt-get install -y python3 graphviz default-jre
+- pip --user install m2r Sphinx sphinx-rtd-theme
+- mkdir ~/plantuml; curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
+
+For PDF generation:
+- sudo apt-get install -y doxygen-latex
+
+###### Windows
+- Python3 [(native Windows version)](https://www.python.org/downloads/)
+- pip --user install m2r Sphinx sphinx-rtd-theme
+- [Graphviz 2.38](https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi)
+- The Java runtime is part of the DS5 installation or can be
+ [downloaded from here](https://www.java.com/en/download/)
+- [PlantUML](http://sourceforge.net/projects/plantuml/files/plantuml.jar/download)
+
+For PDF generation:
+- [MikTeX](https://miktex.org/download)
+
+*Note* When building the documentation the first time, MikTeX might prompt for
+installing missing LaTeX components. Please allow the MikTeX package manager to
+set-up these.
+
+##### Configure the shell
+
+###### Linux
+
+~~~
+export PLANTUML_JAR_PATH="~/plantuml/plantuml.jar"
+~~~
+
+###### Windows + Cygwin
+
Assumptions for the settings below:
- plantuml.jar is available at c:\plantuml\plantuml.jar
- doxygen, dot, and MikTeX binaries are available on the PATH.