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

Don't build Quickstart with docs #42

Closed
sethaxen opened this issue Jan 23, 2020 · 2 comments
Closed

Don't build Quickstart with docs #42

sethaxen opened this issue Jan 23, 2020 · 2 comments

Comments

@sethaxen
Copy link
Member

Currently several PRs are halted because the documentation build stalls when building quickstart. It's hard to tell what the culprit here is, since Documenter doesn't output very detailed debugging logs. It would be good to pre-build Quickstart and periodically update it manually, similarly to how ArviZ does it.

Unfortunately, Documenter has no way to integrate Jupyter notebooks or pre-built HTML files, so for the moment, this will probably require linking to a Jupyter notebook in the repo or in nbviewer.

@sethaxen
Copy link
Member Author

sethaxen commented Feb 9, 2020

Alternatively, we can use the datasets packaged with ArviZ to showcase the plots in a quickstart. From there, we can link to individual notebooks in an examples folder for Turing, CmdStan, and Soss. This way we can avoid some of the compatibility clashes that sometimes arise between these packages.

I'll write the examples so that I can use Literate.jl to turn them into either notebooks or markdown, but this will still be done locally and periodically updated instead of using CI.

@sethaxen
Copy link
Member Author

Closing in favor of building the docs on Azure (#48), which can handle long builds.

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