Skip to content

Commit 5d1d035

Browse files
committed
Fix formatting for docs
Signed-off-by: Ivan Kanakarakis <[email protected]>
1 parent 0c1873d commit 5d1d035

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/howto/config.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ General directives
6767
additional_cert_files
6868
^^^^^^^^^^^^^^^^^^^^^
6969

70-
Format::
70+
Example::
7171

7272
additional_cert_files: ["other-cert.pem", "another-cert.pem"]
7373

@@ -79,29 +79,30 @@ Each entry in *additional_cert_files* must be a PEM formatted file with a single
7979
assurance_certification
8080
^^^^^^^^^^^^^^^^^^^^^^^
8181

82-
Format::
82+
Example::
8383

8484
"assurance_specification": [
8585
"https://refeds.org/sirtfi",
8686
]
8787

88-
Generates an `Attribute` element with name-format
89-
`urn:oasis:names:tc:SAML:2.0:attrname-format:uri` and name
90-
`urn:oasis:names:tc:SAML:attribute:assurance-certification` that contains
91-
`AttributeValue` elements with the given values from the list.
92-
The element is added under the generated metadata `EntityDescriptor` as an
93-
`Extension` element under the `EntityAttributes` element.
88+
Generates an ``Attribute`` element with name-format
89+
``urn:oasis:names:tc:SAML:2.0:attrname-format:uri`` and name
90+
``urn:oasis:names:tc:SAML:attribute:assurance-certification`` that contains
91+
``AttributeValue`` elements with the given values from the list.
92+
The element is added under the generated metadata ``EntityDescriptor`` as an
93+
``Extension`` element under the ``EntityAttributes`` element.
9494

9595
Read more about `representing assurance information at the specification <https://wiki.oasis-open.org/security/SAML2IDAssuranceProfile>`_.
9696

9797
attribute_map_dir
9898
^^^^^^^^^^^^^^^^^
9999

100-
Format::
100+
Points to a directory which has the attribute maps in Python modules.
101+
102+
Example::
101103

102104
"attribute_map_dir": "attribute-maps"
103105

104-
Points to a directory which has the attribute maps in Python modules.
105106
A typical map file will look like this::
106107

107108
MAP = {
@@ -138,7 +139,7 @@ automatically create the other.
138139
cert_file
139140
^^^^^^^^^
140141

141-
Format::
142+
Example::
142143

143144
cert_file: "cert.pem"
144145

@@ -175,7 +176,7 @@ and **other**.::
175176
debug
176177
^^^^^
177178

178-
Format::
179+
Example::
179180

180181
debug: 1
181182

@@ -184,7 +185,7 @@ Whether debug information should be sent to the log file.
184185
entityid
185186
^^^^^^^^
186187

187-
Format::
188+
Example::
188189

189190
entityid: "http://saml.example.com/sp"
190191

@@ -196,7 +197,7 @@ The globally unique identifier of the entity.
196197
key_file
197198
^^^^^^^^
198199

199-
Format::
200+
Example::
200201

201202
key_file: "key.pem"
202203

0 commit comments

Comments
 (0)