Fix PSA Crypto API links in README #125
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Link to the PDF file, not to a page with an embedded PDF reader
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.
gilles-peskine-arm
added
bug
Contributor
|
I don't think we should use a gh-pages branch. I'd like to just merge once into our development branch, into its docs folder, and have github publish from there. This may mean we need to rename our development branch to master. That might not be a bad thing, since most other git-based projects use master as the name for the branch we use as our development branch. |
Contributor
|
I've manually tested the links. They work! |
Patater
removed
the
needs: review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PDF link was to a preview page. Link to the actual PDF instead.
The HTML link went to a third-party service that broke links. Link to Github Pages instead. This requires the HTML to be in
/docson themasterbranch. Alternatively we could change the repository settings to use a dedicatedgh-pagesbranch — @Patater should we do this?There is still a problem with the HTML: Sphinx puts resources (CSS, JS, images) in a directory with the hard-coded name#127 makes_staticbut Github Pages ignores files whose name starts with an underscore. We need to find a solution for this, but in the meantime, unformatted HTML isn't as bad as missing content._staticwork.