diff options
| author | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2020-07-10 19:39:07 +0300 |
|---|---|---|
| committer | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2020-07-10 20:10:53 +0300 |
| commit | 5d1d035bfb73012b00c63b4f7548afacd5585812 (patch) | |
| tree | c1a8e264c8751efcce2877fb383689aac897064a | |
| parent | 0c1873da1f280d4921b9c9b3da9126388d75e701 (diff) | |
| download | pysaml2-5d1d035bfb73012b00c63b4f7548afacd5585812.tar.gz | |
Fix formatting for docs
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
| -rw-r--r-- | docs/howto/config.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/howto/config.rst b/docs/howto/config.rst index 6e2bb635..9f20eba6 100644 --- a/docs/howto/config.rst +++ b/docs/howto/config.rst @@ -67,7 +67,7 @@ General directives additional_cert_files ^^^^^^^^^^^^^^^^^^^^^ -Format:: +Example:: additional_cert_files: ["other-cert.pem", "another-cert.pem"] @@ -79,29 +79,30 @@ Each entry in *additional_cert_files* must be a PEM formatted file with a single assurance_certification ^^^^^^^^^^^^^^^^^^^^^^^ -Format:: +Example:: "assurance_specification": [ "https://refeds.org/sirtfi", ] -Generates an `Attribute` element with name-format -`urn:oasis:names:tc:SAML:2.0:attrname-format:uri` and name -`urn:oasis:names:tc:SAML:attribute:assurance-certification` that contains -`AttributeValue` elements with the given values from the list. -The element is added under the generated metadata `EntityDescriptor` as an -`Extension` element under the `EntityAttributes` element. +Generates an ``Attribute`` element with name-format +``urn:oasis:names:tc:SAML:2.0:attrname-format:uri`` and name +``urn:oasis:names:tc:SAML:attribute:assurance-certification`` that contains +``AttributeValue`` elements with the given values from the list. +The element is added under the generated metadata ``EntityDescriptor`` as an +``Extension`` element under the ``EntityAttributes`` element. Read more about `representing assurance information at the specification <https://wiki.oasis-open.org/security/SAML2IDAssuranceProfile>`_. attribute_map_dir ^^^^^^^^^^^^^^^^^ -Format:: +Points to a directory which has the attribute maps in Python modules. + +Example:: "attribute_map_dir": "attribute-maps" -Points to a directory which has the attribute maps in Python modules. A typical map file will look like this:: MAP = { @@ -138,7 +139,7 @@ automatically create the other. cert_file ^^^^^^^^^ -Format:: +Example:: cert_file: "cert.pem" @@ -175,7 +176,7 @@ and **other**.:: debug ^^^^^ -Format:: +Example:: debug: 1 @@ -184,7 +185,7 @@ Whether debug information should be sent to the log file. entityid ^^^^^^^^ -Format:: +Example:: entityid: "http://saml.example.com/sp" @@ -196,7 +197,7 @@ The globally unique identifier of the entity. key_file ^^^^^^^^ -Format:: +Example:: key_file: "key.pem" |