Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github-pages & update landing page docs #46

Closed

Conversation

lucianojoublanc-da
Copy link
Contributor

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 the docs/ folder manually for the time being, after building docs locally (using make 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.

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.
@lucianojoublanc-da
Copy link
Contributor Author

You can preview the docs at https://lucianojoublanc-da.github.io/dazl-client

@da-tanabe
Copy link
Contributor

Closing this fork-based PR in favor of a branch-based one (#103).

@da-tanabe da-tanabe closed this Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants