Skip to content

Commit 8e44834

Browse files
Anton-TFAnton-TF
committed
docs: A set of cosmetical changes in documentation
- limit page width to 1100px and adjust frontpage tiles - make glossary flat structure (remove sub sections) - add favicon - disable "View page source" link - disable Prev,Next buttons - disable "Built with Sphinx ..." in page footer - add captions to some pages to shrink names in TOC Signed-off-by: Anton Komlev <[email protected]> Change-Id: Ib6844b118c25b4437d7f11014112533fd8d5547b
1 parent b813dbc commit 8e44834

File tree

6 files changed

+75
-86
lines changed

6 files changed

+75
-86
lines changed

‎docs/_static/css/tfm_custom.css

+13-21
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
#
66
#----------------------------------------------------------------------------*/
77

8-
/* Expand width to fill screen */
9-
.wy-nav-content {
10-
max-width: none;
8+
/* Limit page width */
9+
@media only screen and (min-width: 780px) {
10+
.wy-nav-content {
11+
max-width: 1100px;
12+
}
1113
}
1214

1315
/* Flexbox Tile Grid Settings */
@@ -30,16 +32,16 @@
3032
-webkit-box-flex: 0;
3133
-ms-flex: 0 0 auto;
3234
flex: 0 0 auto;
33-
width: 220px;
35+
width: 200px;
3436
text-align: center;
3537
margin: 1rem;
3638
}
3739

3840
.grid-item a {
3941
display: block;
40-
width: 220px;
41-
height: 220px;
42-
padding: 22px;
42+
width: 190px;
43+
height: 190px;
44+
padding: 12px;
4345
display: -webkit-box;
4446
display: -ms-flexbox;
4547
display: flex;
@@ -59,27 +61,17 @@
5961
}
6062

6163
.grid-item h2 {
62-
font-size: 1.1rem;
64+
font-size: 1rem;
65+
margin-bottom: 0.5rem;
6366
}
6467

6568
.grid-item img {
66-
margin-bottom: 1.1rem;
6769
max-width: 75%;
70+
margin-bottom: 0.5rem;
6871
}
6972

73+
7074
.grid-item a:hover {
7175
background-color: #32cd32;
7276
color: white;
7377
}
74-
75-
76-
.grid-item p {
77-
margin-top: 0.5rem;
78-
color: #333e48;
79-
}
80-
81-
.grid-icon {
82-
line-height: 1.8;
83-
font-size: 6rem;
84-
color: #343131;
85-
}

‎docs/_static/images/favicon.ico

4.19 KB
Binary file not shown.

‎docs/conf.py

+16-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,15 @@
106106
# further. For a list of options available for each theme, see the
107107
# documentation.
108108
#
109-
html_theme_options = {'collapse_navigation': False}
109+
html_theme_options = {
110+
'collapse_navigation': False,
111+
'prev_next_buttons_location' : None # Hide Prev and Next buttons
112+
# 'display_version': True, # Show version under logo
113+
}
114+
115+
# Remove the "View page source" link from the top of docs pages
116+
html_show_sourcelink = False
117+
110118
#
111119
# Add any paths that contain custom static files (such as style sheets) here,
112120
# relative to configuration directory. They are copied after the builtin static
@@ -116,6 +124,9 @@
116124
# Set the documentation logo relative to configuration directory
117125
html_logo = '_static/images/tf_logo_white.png'
118126

127+
# Set the documentation favicon
128+
html_favicon = '_static/images/favicon.ico'
129+
119130
# Custom sidebar templates, must be a dictionary that maps document names
120131
# to template names.
121132
#
@@ -129,6 +140,10 @@
129140
#Disable adding conf.py copyright notice to HTML output
130141
html_show_copyright = False
131142

143+
# Disable showing Sphinx footer message:
144+
# "Built with Sphinx using a theme provided by Read the Docs. "
145+
html_show_sphinx = False
146+
132147
#Add custom css for HTML. Used to allow full page width rendering
133148
def setup(app):
134149
app.add_css_file('css/tfm_custom.css')

‎docs/glossary.rst

+37-62
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,31 @@
22
Glossary of terms and abbreviations
33
###################################
44

5-
************
6-
TF-M related
7-
************
85
.. glossary::
6+
:sorted:
97

108
Application RoT
11-
Application Root of Trust
129
`PSA term`_. The security domain in which additional security services
1310
are implemented.
1411

1512
HAL
16-
Hardware Abstraction Layer
13+
Hardware Abstraction Layer:
1714
Interface to abstract hardware-oriented operations and provides a set of
1815
APIs to the upper layers.
1916

2017
RoT
21-
Root of Trust
18+
Root of Trust:
2219
`PSA term`_. This is the minimal set of software, hardware and data that
2320
is implicitly trusted in the platform — there is no software or hardware
2421
at a deeper level that can verify that the Root of Trust is authentic
2522
and unmodified.
2623

2724
RoT Service
28-
Root of Trust Service.
2925
`PSA term`_. A set of related security operations that are implemented
3026
in a Secure Partition.
3127

32-
NSPE : TF-M related
33-
Non Secure Processing Enviroment
28+
NSPE
29+
Non Secure Processing Enviroment:
3430
`PSA term`_. In TF-M this means non secure domain typically running an
3531
OS using services provided by TF-M.
3632

@@ -44,111 +40,90 @@ TF-M related
4440
`PSA term`_. Platform Security Architecture Firmware Framework for M.
4541

4642
PSA RoT
47-
PSA Root of Trust
4843
`PSA term`_. This defines the most trusted security domain within a PSA
4944
system.
5045

51-
SFN : TF-M related
52-
Secure Function
46+
SFN
47+
Secure Function:
5348
The function entry to a secure service. Multiple SFN per SS are
5449
permitted.
5550

56-
SP : TF-M related
57-
Secure Partition
51+
SP
52+
Secure Partition:
5853
A logical container for secure services.
5954

60-
SPE : TF-M related
61-
Secure Processing Environment
55+
SPE
56+
Secure Processing Environment:
6257
`PSA term`_. In TF-M this means the secure domain protected by TF-M.
6358

64-
SPM : TF-M related
65-
Secure Partition Manager
59+
SPM
60+
Secure Partition Manager
6661
The TF-M component responsible for enumeration, management and isolation
6762
of multiple Secure Partitions within the TEE.
6863

69-
SPRT : TF-M related
70-
Secure Partition Runtime
64+
SPRT
65+
Secure Partition Runtime:
7166
The TF-M component responsible for Secure Partition runtime
7267
functionalities.
7368

74-
SPRTL : TF-M related
75-
Secure Partition Runtime Library
69+
SPRTL
70+
Secure Partition Runtime Library:
7671
A library contains the SPRT code and data.
7772

78-
SS : TF-M related
79-
Secure Service
73+
SS
74+
Secure Service:
8075
A component within the TEE that is atomic from a security/trust point of
8176
view, i.e. which is viewed as a single entity from a TF-M point of view.
8277

83-
PS : TF-M related
84-
Protected Storage
85-
Protected storage service provided by TF-M.
78+
PS
79+
Protected Storage service provided by TF-M.
8680

87-
ITS : TF-M related
88-
Internal Trusted Storage
81+
ITS
8982
Internal Trusted Storage service provided by TF-M.
9083

9184
TFM
9285
TF-M
93-
Trusted Firmware-M
94-
Trusted Firmware for M-class
86+
Trusted Firmware-M or Trusted Firmware for M-class.
9587
ARM TF-M provides a reference implementation of secure world software
9688
for ARMv8-M.
9789

9890
TBSA-M
99-
Trusted Base System Architecture for Armv6-M, Armv7-M and Armv8-M
91+
Trusted Base System Architecture for Armv6-M, Armv7-M and Armv8-M.
10092
TBSA term. See `Trusted Base System Architecture for Armv6-M, Armv7-M
10193
and Armv8-M`_
10294

103-
****************
104-
SSE-200 platform
105-
****************
106-
.. glossary::
107-
108-
MPC : SSE-200 platform
109-
Memory Protection Controller
95+
MPC
96+
Memory Protection Controller:
11097
Bus slave-side security controller for memory regions.
11198

112-
PPC : SSE-200 platform
113-
Peripheral Protection Controller
99+
PPC
100+
Peripheral Protection Controller:
114101
Bus slave-side security controller for peripheral access.
115102

116-
************
117-
v8M-specific
118-
************
119-
.. glossary::
120-
121-
S/NS : v8M-specific
122-
Secure/Non-secure
103+
S/NS
104+
Secure/Non-secure:
123105
The separation provided by TrustZone hardware components in the system.
124106

125-
SAU : v8M-specific
126-
Secure Attribution Unit
107+
SAU
108+
Secure Attribution Unit:
127109
Hardware component providing isolation between Secure, Non-secure
128110
Callable and Non-secure addresses.
129111

130-
***************
131-
M-class Generic
132-
***************
133-
.. glossary::
134-
135112
AAPCS
136-
ARM Architecture Procedure Call Standard
113+
ARM Architecture Procedure Call Standard:
137114
The AAPCS defines how subroutines can be separately written, separately
138115
compiled, and separately assembled to work together. It describes a
139116
contract between a calling routine and a called routine
140117

141-
MPU : M-class Generic
142-
Memory Protection Unit
118+
MPU
119+
Memory Protection Unit:
143120
Hardware component providing privilege control.
144121

145122
SVC
146-
SuperVisor Call
123+
SuperVisor Call:
147124
ARMv7M assembly instruction to call a privileged handler function
148125

149-
*********
150-
Reference
151-
*********
126+
.. rubric:: Reference
152127

153128
| `PSA Firmware_Framework for M`_
154129

‎docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Trusted Firmware-M Documentation
9292
API Reference <https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/reference_manual/html/index.html>
9393
Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
9494
Platform Security Architecture <https://developer.arm.com/architectures/security-architectures/platform-security-architecture>
95-
glossary
95+
Glossary <glossary>
9696

9797
--------------
9898

‎docs/integration_guide/services/index.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@ Services
55
:maxdepth: 1
66
:glob:
77

8-
*
8+
Initial Attestation <tfm_attestation_integration_guide>
9+
Audit Log <tfm_audit_integration_guide>
10+
Crypto <tfm_crypto_integration_guide>
11+
Internal Storage <tfm_its_integration_guide>
12+
Platform <tfm_platform_integration_guide>
13+
Protected Storage <tfm_ps_integration_guide>
14+
PSA Proxy <tfm_psa_proxy_integration_guide>
15+
How to add a partition <tfm_secure_partition_addition>
916

1017
--------------
1118

0 commit comments

Comments
 (0)