From 7b3950862f9deca4d2299a20ab9a4910aa9378e8 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Thu, 31 Jan 2019 11:56:02 +0100 Subject: [PATCH] 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. --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b5215329..785584a62 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,24 @@ Mbed Crypto is a reference implementation of the PSA cryptography API. It is wri ## Documentation -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: +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. -* The [PSA Cryptography API overview](docs/PSA_Crypto_API_Overview.pdf). -* 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). +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. + +### PSA Cryptography API + +The PSA cryptography API specification consists of the following documents: + +* The [PSA Cryptography API overview](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf). +* 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). + +### Browsable library documentation + +To generate a local copy of the library documentation in HTML format: + +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. +1. Run `make apidoc`. +1. Browse `apidoc/index.html` or `apidoc/modules.html`. ## Compiling