Add github-pages & update landing page docs #46
Closed
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 adds a root
docs/
folder where documentation is now generated, for #45 . Generating this automatically with CI is more complicated and I couldn't get this working after an hour of tinkering. The downside of this is that we need to commit changes to thedocs/
folder manually for the time being, after building docs locally (usingmake build
, or `cd python && make docs). Would be nice to switch to CI doc builds in the future.To enable the github pages docs, you'll need to enable them in github settings, toward the bottom of the page. The docs will then be hosted online at https://digital-asset.github.io/dazl-client
Also note that there appears to be something wrong with the CSS styles. Would appreciate if somebody with more knowledge of CSS/Sphinx could check that out.
I updated the README/index files to reflect that the build system is now Poetry, and also added a note that the library can be installed using
pip
, for the casual user.