-
-
Notifications
You must be signed in to change notification settings - Fork 378
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
README gallery #204
README gallery #204
Conversation
2. Clone this repo, | ||
3. Run `./scripts/start_container.sh` | ||
|
||
This should start a local docker container called arviz, as well as a Jupyter notebook server running on port 8888. The notebook should be opened in your browser automatically (you can disable this by passing --no-browser). The container will be running the code from your local copy of arviz, so you can test your changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add one line saying you should run tests, and also can lint code with ./lint.sh if desired
You have one commit labels WIP. I think that could have a better commit message! |
Interesting - I had thought commits were getting squashed, but I see a few silly commit messages. Do you know an easy way to fix that? Maybe we default to doing "squash and merge"? |
Agree "squash and merge" should be the default |
I turned off the merge commit and rebase so there should only be one option now |
Check hash
and the squash, and fixup if needed. |
Some minor edits, but mostly adding a gallery to the readme.
Note that I am linking the images directly to the documentation, instead of internally into the github repo. This is a little risky (if the documentation goes down, the README looks bad), but makes the README portable: the images will still display on pypi, for example.
You can see it at https://github.com/ColCarroll/arviz/tree/pretty-docs