search

digital-asset / dazl-client

dazl Ledger API client
Apache License 2.0
10 stars 6 forks source link

Make documentation available through github pages #45

Open lucianojoublanc-da opened 4 years ago

lucianojoublanc-da commented 4 years ago

The docs are generated with Sphinx. There are couple of howto's on the web explaining how to make the doc available through github pages. TL;DR put generated html under docs/.

Ideally this should be autogenerated with CI - this may be trickier.

Would be nice to reuse the theme from https://docs.daml.com for consistency.

lucianojoublanc-da commented 4 years ago

I've got a simple solution using gh-pages (see PR #46 ), however the styling doesn't appear to work - either that or it's just very ugly :rofl: . I don't know if it's the best use of my time trying to resolve this. Somebody with knowledge of CSS and how Sphinx works may be better placed to tackle this - but I'm happy to give it a go if that is the consensus.