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

Documentation rewrite #3275

Merged
merged 8 commits into from
Nov 29, 2018
Merged

Documentation rewrite #3275

merged 8 commits into from
Nov 29, 2018

Conversation

ColCarroll
Copy link
Member

I think this is ready to go. This dramatically reorganizes the documentation. A live demo is being hosted at
https://colindcarroll.com/static/pymc3/

Note that some of the links are broken in the demo because absolute links will start my website's root, not the documentation root (they will work on the actual doc site).

Major changes:

  • UI and CSS is custom, using semantic-ui. I did this because it looks clean and different from bootstrap, so it feels unique. most of these changes are in layout.html
  • Example gallery has pictures and categories. categories can be manually edited in notebooks/table_of_contents.js. The title is taken from the first cell with an h1 in it, and the image is the last png (there's a GP notebook that is pure Bokeh!).
  • Search UI is cleaner, and search logic is better (searching for "normal" now brings up the normal distribution first)
  • Dedicated page to resources for learning about bayesian statistics with pymc3

image

image

@ColCarroll
Copy link
Member Author

Oh, and note that since we only deploy docs on the latest release, we can either run this on the 3.5 tag and push manually, or wait till next version to actually deploy.


<h1 class="ui header">Learn Bayesian statistics</h1>

<h2 class="ui header">...with others!</h2>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this all hand-written?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep. we could do this from a configuration file or something, but I think copy/pasting for each new book is fine.

@twiecki
Copy link
Member

twiecki commented Nov 28, 2018 via email

@twiecki
Copy link
Member

twiecki commented Nov 28, 2018

Or we could cut a new release.

@twiecki
Copy link
Member

twiecki commented Nov 28, 2018

I would definitely add this to the release-notes.

@ColCarroll Anything in specific you want feedback on? Otherwise we can probably just merge this.

@ColCarroll
Copy link
Member Author

I'll add to readme, and also put the badges from github on the front page (forgot!)

I think in terms of feedback, mostly looking for "this is at least as good as current docs, and has some improvements". There are a bunch of rough edges that I would like to fix in smaller followup PRs (or at least open issues describing those so that anyone can tackle them).

@junpenglao
Copy link
Member

It's a great improvement compare to our current doc, thanks for the hard work @ColCarroll!
Yeah we should cut a release after this.

@ColCarroll
Copy link
Member Author

Should be all set. I also shuffled release notes a bit, since most folks are interpreting sample_ppc -> sample_posterior_predictive as a deprecation rather than maintenance.

@junpenglao junpenglao merged commit ce3c967 into master Nov 29, 2018
@eigenfoo eigenfoo deleted the new-docs branch January 1, 2020 22:08
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.

3 participants