From 58501e5ecc88496089374f7d143ea422921cd241 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Thu, 23 May 2019 19:28:12 +0200 Subject: [PATCH 1/2] API spec PDF: link to the actual PDF Link to the PDF file, not to a page with an embedded PDF reader --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e243fe7e8..8d9f2de95 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ There are currently a few deviations where the library does not yet implement th ### PSA Cryptography API -You can read the [complete PSA cryptography API specification as a PDF document](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf). The API reference is also available in [HTML format](https://htmlpreview.github.io/?https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/html/index.html). +You can read the [complete PSA cryptography API specification as a PDF document](https://github.com/ARMmbed/mbed-crypto/raw/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf). The API reference is also available in [HTML format](https://htmlpreview.github.io/?https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/html/index.html). ### Browsable library documentation From f81f87f4ccb47c59791a5a1e604ddf42348290eb Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Thu, 23 May 2019 19:30:32 +0200 Subject: [PATCH 2/2] API spec HTML: Use Github Pages rather than htmlpreview htmlpreview.github.io breaks some links: in index.html viewed through this service, the links that should go to from_doxygen.html are shown as internal links, so the meat of the document is invisible. Link to Github pages instead. This relies on the documentation being available on the `master` branch of the mbed-crypto repository. This has the added benefit of not depending on a third-party service. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d9f2de95..9d34c556a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ There are currently a few deviations where the library does not yet implement th ### PSA Cryptography API -You can read the [complete PSA cryptography API specification as a PDF document](https://github.com/ARMmbed/mbed-crypto/raw/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf). The API reference is also available in [HTML format](https://htmlpreview.github.io/?https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/html/index.html). +You can read the [complete PSA cryptography API specification as a PDF document](https://github.com/ARMmbed/mbed-crypto/raw/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf). The API reference is also available in [HTML format](https://armmbed.github.io/mbed-crypto/html/index.html). ### Browsable library documentation