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

Make documentation available through github pages #45

Open
lucianojoublanc-da opened this issue Aug 28, 2019 · 1 comment
Open

Make documentation available through github pages #45

lucianojoublanc-da opened this issue Aug 28, 2019 · 1 comment

Comments

@lucianojoublanc-da
Copy link
Contributor

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 lucianojoublanc-da changed the title Add documentation to github pages Make documentation available through github pages Aug 28, 2019
@lucianojoublanc-da
Copy link
Contributor Author

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 🤣 . 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.

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

No branches or pull requests

1 participant