Open
Conversation
… AND created more documentation pages (that are WIP)
… AND Doxygen generation is seperated for now
Merge branch 'ecdsa-betterReadMe' of https://github.com/ubirch/ubirch-protocol-python into ecdsa-betterReadMe
…-protocol-python into ecdsa-betterReadMe
…ion. Doxygen with HTML - and Jekyll with Markdown files
…ions in Doxygen Cofiguration
UBOK19
reviewed
Jun 23, 2022
UBOK19
suggested changes
Jun 23, 2022
UBOK19
suggested changes
Jun 25, 2022
UBOK19
reviewed
Jun 27, 2022
UBOK19
left a comment
UBOK19
left a comment
There was a problem hiding this comment.
Looks good to me; @gruenwaldi should have a final look at it before deciding about merging
gruenwaldi
suggested changes
Jul 2, 2022
gruenwaldi
left a comment
gruenwaldi
left a comment
There was a problem hiding this comment.
Please check all the comments and then let us have a look together
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
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.
This branch is branched off from
ecdsa-examples. So first merge to there.The README and the Installation, Setup and Getting Started in it were improved and made up-to-date.
That, a Step By Step guide and other explanation resources are added as markdown files in
docs/.These are deployed and rendered as HTML automatically on https://developer.ubirch.com/ubirch-protocol-python/ using
JekyllThe docstrings inside the ubirch library files were rewritten and are automatically parsed by
Doxygento write the function-documentation at https://developer.ubirch.com/function_documentation/ubirch-protocol-python/Configurations for these tools can be found in the
docs/folder._configandGemfilehave to be in there as well.The automation is accomplished with the workflow
.github/workflowsand configured github pages.Inside of
examples/is the code referenced and used in the guides.The repository was cleaned up and
examples/test-web-of-trust.pydeleted.PS: Some day someone should fix the typo in
protocol.verfiy_signature()