From 653279b015080969eaf4ac85b1e3a31965666550 Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Wed, 23 Jan 2019 15:39:39 +0000 Subject: [PATCH] doc: Add minimal Sphinx support 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: Paul Beesley --- docs/Makefile | 25 ++++++ docs/conf.py | 72 ++++++++++++++++++ docs/index.rst | 47 ++++++++++++ .../TrustedFirmware-Logo_standard-white.png | Bin 0 -> 5826 bytes 4 files changed, 144 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/resources/TrustedFirmware-Logo_standard-white.png diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..eed3a0815 --- /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 +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..0fcc50d2f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,72 @@ +# -*- 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 + +# -- Project information ----------------------------------------------------- + +project = 'Trusted Firmware-A' + +version = '2.1' +release = version # We don't need these to be distinct + + +# -- 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 = [] + +# 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' + + +# -- 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 +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..a6c1ca92c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +Arm Trusted Firmware-A Documentation Index +========================================== + +.. toctree:: + :maxdepth: 1 + :caption: Design Documents + + arm-sip-service + auth-framework + + .. toctree:: + :maxdepth: 1 + :caption: Release Notes + change-log + + .. toctree:: + :maxdepth: 1 + :caption: Guides + + .. toctree:: + :maxdepth: 1 + :caption: Policies + cpu-specific-build-macros + exception-handling + firmware-design + firmware-update + interrupt-framework-design + platform-compatibility-policy + platform-interrupt-controller-API + porting-guide + psci-lib-integration-guide + psci-pd-tree + ras + reset-design + rt-svc-writers-guide + sdei + secure-partition-manager-design + trusted-board-boot + user-guide + xlat-tables-lib-v2-design + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/resources/TrustedFirmware-Logo_standard-white.png b/docs/resources/TrustedFirmware-Logo_standard-white.png new file mode 100644 index 0000000000000000000000000000000000000000..e7bff7128fe6abb3341f63622769a0a5b94e8717 GIT binary patch literal 5826 zcmZ8lXEdN1_czXQJ1HC^LG?sL_pxE@~u1Vnh!j>Ig}+ zM+u^LzRCN&*Z1T5an3&LoPE~5*4pd7*Ex5hsj)7Al9iHxfB>Ke(KaI>AQZ)4gUCto z=kMQ9kMILwfSIl)LBkmPCf>N?reUN(K=3A=>Iz1Jw<(@LYyt=fsObJ4gi$UInfRN` zfjZDYbA)SP2+SW&@C4@J8z}Az59F2=mlBu1Hm2AhAYhWw)7G#EwcjbCC}fx}8u0o^ z%>L0il|IGV&~SP8VFjC%xbh;l%yu7~5=t^I=$VqW2uw|rsuFoPvAN6gF(Am=G>s+A zrGhk;IrB9HL@r6pN(Tb-M<tNj- zZpj!5;!Gb{+5f+xD5)mNSL2<3leX_J$j{LxKB+K?Bb7i_CuBVKeIOk-I*Ms(5P9qNCa`9z2zhJ+I<#WlQ=U1lRv!+*O=8{ zanHl37Nr?GLC<)DVo%)l&!o{>sy<~iI#z2!1WN*drH)g+dax&}zlnSq|HMeSPO~7u z%k`~Qo4tP)8dQ|@_s!@YA|D}5u94H;bwL|T6v@II$-=m5CS=VF2a7{klH31~6z!|6 zv|w=W(PLU`Mi@MLe)do(Oqo$kt}fAfhjS`zYqoNIsss&38jIAjoM>j$TzPd=)Ar0& zG{ByP*lAW}J~h!$D9GK3I;0ockzB20481nt zuLs*^!RTzzBWip?ZT5mf{3cc9ok+`wO%1pl76FisT|(x&_yoPYfVAsAb+%m?-e$|m zomH@JIc@D%g^PXu=8t{ETXO39e9a`oG6>p~&oSJTfMJ~D#5MudiHw?#4A8zwe98Vc zoHY(qi=>wNxNn<+(@ncvkL|4@hNDO}Z@6#|7;~{rt&XJx%_M~ra zvwYs`;i7}w5$+~}|3U~yg8x0poao;;)UIpSnX;RtoI1O(?Vw+P3=y=c{-eUGuX#)J zlvBy=hwwpnWf8q|!om|}3lckiBe~ZhIyVq^>UBi#QTPV6JD0~K%@obtUDBXW!Th_z zxF+d;ITKZD*4mXiEe4xfpA61DooQBUKIs+2>VL29PMWKF1zrCn3F6=#WQIvU=m5Izf1(>`8>-tZqYkkU~@RD zbqXi&oNRh$%<`2h!t$}V^Kex;b#jdt^jpA8P2=Fms(@_WQ26_ALnEr8F^8vWk{bV6iL?Y}<7M%BJNq&6~V9w)SJ1$5s zzU@gCI&&bCuK<3=FH3y^Hd87M&cqQ!p9kP^4SJ|g*(af&*apbksG#brLS+N{X7T1> zX}y_$jB@I>rj7RVRv&0ot__LPbw2jWFL;pzXEDON1Cc_-$yEu&9!1BXqT7??>rA~O z#zNPggvlw0f%rzrZYaLU)s2^m(F+50k?^QaeQD7?^-MF3i8O~%aZ^2H{MrYywW};# z>5zF|Uk~)XmI2n&Z?K$Fbb%gQz%!z~DksV&T1!p!4UI`6+ELFII@jiR=I)@mdwk>g zftD?v(egbiEaqGSqHL@#)H3!=1+ZL^KOlNq2x!slVsQHLLtjq_i0Iee3v*tQ6lH6* zE>Rji`FK?z$rcmJ(dQS)?&@^4n6MD0sArC}JS@UGTCw?PdFu1CTD5mIz`{O_ozb{L z#Z3_nu%~<;;t>QGl$GN%5etAFVI{MH-t)W&LR)0eZo3!o@DK7_1o+HyW?Yr;a>9u- zQ0_=3!9f$SJTiqO9CZ-)AaN=$P59 zhf#GY40di(DmOt1$tQbt7gGlwRh_Pty3{f3p-|HO{&3seS|XTU5icj#S6CECBdX3qA6mPf2*2W&}E4`-2X?c+_8H5$$UW`4vUP&jY8d4D@2ZhYE=R zf28Z>qit>}8Mu;9>d?@~d`cwC4*K}KaeV48eu-uf%npBLb$Si^;EwIx?xN&KwYd(V zTcySltza&;UOWy0EDXEV2c|b}<{^V} z(9{`te5GcgiS`2_Q4<-V!`f+yCS=DKo@K{sfJ-8WSTt*zTjGqvMRgv&{~*Oy(ujqcWr@7PIx2hPWo zCVN&v94#if$&7@b{!m0z#|Dc@iE=K@qc{*?P=o^OH>^|;4VlJ=QW(!Ppz~~3^%o~E z?U&`|)O@$$4}4`reid~y1n1=dDk<9e9Gh^?@B+;joXzfdKusj@7I>oGGGjXc20_HY zxCkDrYx`csK7m2d!ol7<6U~0m8);2V5~me!aWi(`Pgs`~Q#`S_V>Jg`hWz}gsdi3t zA62)maBqQ-)0HPvR6gdzRg0dauDM-zPYA`s53_$~n=EB=oc3n@J}~-~`MFD>1KnCR z?G?Q8rkQ2oZ$x`Mt?yuTqUxl>o2&eTFDxhEcksF7H zRI`-&|Hk4FyTU$?1XPca-wF#07GGb&Wo7FE4?x|E?8RRxf0oRwBje8)ggh{q%vRFs zJ2{tk(R;Xu4I%Om!o8{2UrN_qW2X4rM{YVH?1rIn_{LT8Vw#m3!OY~ON=|=R?+OLK z1k5aCQj7SSHfoLQLEJAuB2`Fz$Kib=cH&nbyOdwDJfBm1oN}hL0U15ed=~s}fn%MY zg~|VfQ-RjzTr1SWcF>Oc&7mDd=VYUWhkQuk6ZZ^b5ZQ}x`^1ooRzU5$8r=+*KYA_@ zqs?7-&*vW*Uua%lIu|7?FAjV-ORHJz`n_oDJba&>sR1oEpN7NgH{d=j4yluvr-h`E zi<4Xt|HgK;&tZqpoyt?CZgeL}AuU=tv1}5bK!}Bd0#EPqp1?ebvv@7fd#lTC++hz= z-2kU8M@s0<28bO`TJKCL;Pwr?*%NSpgb^;%#y>*gTT8z?0`tfl3h|q$Ck=v==RMho z4)2jvM=8-yQ@HvZCcos^_I#^#XL%3L-EZ*}2JL4yN1eF{v6N~Dc_wsj{Am7sKqzx*9=52w(#kzJxcs)fk4lGOY($U zCUM4?w~c59$WBtBUmlTiGi=_~xhHBHgAsD#xN_S5)JHcst$(*6Rvj#!q9xYaa(dGv z$dBhx)F!YMkp`PD5%}=RkC#-*p6*kb1gPRWO~vAhB6Y374vY1}esf6o9>??Unr(|7 z#?Ek9Q1DsTcJ@Qixy8w-+YB6GM|bmc>}i0(NvqCwb9eGibjiHCy?0kEHI?5OoQ5v= zamIL4O=SZZWP>MoH_eOOY)E3;4?X?oa~p9wwmg*y9%joZbndA8L{4rdJ9pd0Y|;BG z*1j&=IIQ&4u}`6ra~;-QSEq=e2}hnMerxQyKqFq;H$>J_p}w`Vd{8uME=vyM0V!C)-WSPQ@VfS*DC z8jbvGmCGi{k!^CU@uvr175fs`D7qBYX!6zLUqtI+EJFrn!&JD5z7zu~;4NfWsr2Cy zH>AvxnrdW8Y($$ux{m!W&)`DtN9G-1?q5uFBB!l~Dfa`)zZ7A8flW?@-~Y$T%Sb> zo$Yy(9A_@RTdvH4E>vC@6WRS+fxg=nmyN2yLv2l!G~e`yO zgG?UEq_78@thSRQ*5rs|(hW14)6dq0pbH}a`}WJgu( z8a@|7sAAKCmegDYaqE%X8E&^kxwn8mpNhn&98bF!<9GFGsx+u z7fBL>GjXk%urN?@n&GR1XzuJhGU79z*L{=h*n&rGCK=y($A%jl#Slt8YrJVV2uYs|ZSE zcl=iku>02)gRH1@*wmX!wdfe(`KB$_nH?#&AVk=-ZP(ufJpfPz<_E4TY1B0Tlq7px z$!vueCD!d_a{gUvl`v*wnQ4FW=e`7P?S6@((}kmu5HMg>VvjY9`qhilmz902CFX<4 zc*HDYIYWQ_`D}(4ZN!k{2L}8|(#;zz+H7dyrL^cId@{ixCJ_GhbWnH(pFOrEk&s56{(jG}kio)IsU-ZdsN}t+@SJ;B2YS3+u|&F6tc2=+irz}CnM)z# zRcqm@>vcB;b={I>urG-|r)NKJo*UU~X3@?&hf|rEoTY+C4Q#AR8+I>a!&sU2h#7l& z6dM^=t_M?p-5X4gD^ys)t6lXPbf`Ge7ZSK0QJFy2lXkUaHgtV2a{3RUtXf_VF6`;c z7glO~ar1xPb+Pfuf{W96tre=UXk@k-31P8z%VVB0(#~DHAXeOtvA`z1R_Z`xuz*wt zk8TI$MTX(fwc}K_@F_Wqke4mP8v?>fGYWOLu}4PJ%iK}wM|SyDFqYFi-BB&@>~-?r zjq}kD0EjGq@{0(`m-P?KVDY!kQ1bB0U^xo6Szk4htP83+iWv?Wjyq(+)-Q@U)30oG}xyX4|#I~qIg#S*Q)_w1X(dvmHL}CIH6;?Ugyz| zrqG@eE`4``@h~R2<2$y7b`j74&8?wszl=lV+J380y${q!XPeE6e)$V-YNhW!@X*zx z>+$P%>Wu67sgZL;T;5?R_$G9z@i%z+iWkgGk*mNw>H!0f*j~_SbB<<}#*es$czN)J zhg{yclxPh5-tw73f#=0bXmgLeUBs@q13o+$c9s4xwVUw8x0`l1bE> zC8#SY%}h{<;7IX4U1l-lu7=7=`#{1a&t9b6I#2M@A>Aryd(e&C_eC>ak_>uau}dox zDhd&>4;Ie0CDdB@U8mzzv|}qLoDC)JUaQm5=Wka&%v7}ZJ}8ap;PXZNwCtLGGS)(% z$~m5>2c0&47N82ON^r0{_E zNM*xrgJ)22^$7oj9swnJuCX8H3u*9} vYwC@(Xjs~&Hh)YEuJKgi6YozQ7*9eGYP^=%mjKm#@Y>