Skip to content

Commit 76825e1

Browse files
Documentation: link to the specification separately
Link to rendered copies of the specification on a separate branch, since the implementation is not always up-to-date with the specification. Fix the broken link to the HTML to something that works on the web. Add instructions to generate the library documentation in HTML locally.
1 parent f8785f7 commit 76825e1

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,24 @@ Mbed Crypto is a reference implementation of the PSA cryptography API. It is wri
2424

2525
## Documentation
2626

27-
Since the Mbed Crypto library is a reference implementation of the PSA cryptography API, the library's API documentation is the PSA cryptography API specification. The PSA cryptography API specification consists of the following documents:
27+
The Mbed Crypto library is a reference implementation of the PSA cryptography API. Please refer to the PSA Cryptography API documents for an overview of the library's interfaces and a detailed description of the types, macros and functions that it provides.
2828

29-
* The [PSA Cryptography API overview](docs/PSA_Crypto_API_Overview.pdf).
30-
* The [PSA Cryptography API detailed function reference](docs/PSA_Crypto_API_Reference.pdf), which you can also browse in [HTML format](docs/html/modules.html).
29+
There are currently a few deviations where the library does not yet implement the latest version of the specification. Please refer to the [compliance issues on Github](https://github.com/ARMmbed/mbed-crypto/labels/compliance) for an up-to-date list.
30+
31+
### PSA Cryptography API
32+
33+
The PSA cryptography API specification consists of the following documents:
34+
35+
* The [PSA Cryptography API overview](https://github.com/gilles-peskine-arm/mbed-crypto/blob/psa-crypto-api-1.0-beta-docs/docs/PSA_Cryptography_API_Specification.pdf).
36+
* The [PSA Cryptography API detailed function reference](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Reference.pdf), which you can also browse in [HTML format](https://htmlpreview.github.io/?https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/html/modules.html).
37+
38+
### Browsable library documentation
39+
40+
To generate a local copy of the library documentation in HTML format:
41+
42+
1. Make sure that [Doxygen](http://www.doxygen.nl/) is installed. We use version 1.8.11 but slightly older or more recent versions should work.
43+
1. Run `make apidoc`.
44+
1. Browse `apidoc/index.html` or `apidoc/modules.html`.
3145

3246
## Compiling
3347

0 commit comments

Comments
 (0)