python: Add github-pages & update landing page docs #103
Conversation
This file contains 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
Added a doc/ dir in the root where generated documentation will be created. This will be done by Sphinx, see python/Makefile.
Examples in the README should now compile. Updated info on build environment (poetry instead of pipenv).
Previously they were not in sync.
- Use poetry instead of pipenv - Update README to reflect this
lucianojoublanc-da
approved these changes
Aug 10, 2020
There was a problem hiding this comment.
Seems fine; It's been a looong while since I looked at this, so I'm trying to remember what other feedback I had.
I think the main thing was that not all APIs for all modules had been generated - the main ones were there, but I recall having to add the ones for writing (or was it reading) from the ledger. I think they were missing from the Sphinx configuration. There are still others which are incomplete. Hope you can add those later.
Another thing I recall I found confusing is that there is a 'postman' example; there also exists an on-line page for testing REST apis with the same name. That may be confusing for some people.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Re-opened #46 as a branch in the repo instead of a fork.
The only material changes I made to it were removing the
docsfolder (I opted to keep them up-to-date on agh-pagesbranch rather than keep them in repo); otherwise this is essentially the same PR, but relatively up-to-date with HEAD.