-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Documentation rewrite #3275
Conversation
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> |
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.
is this all hand-written?
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.
yep. we could do this from a configuration file or something, but I think copy/pasting for each new book is fine.
yes definitely, just asking for my own understanding.
…On Wed, Nov 28, 2018, 20:08 Colin ***@***.*** wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/source/learn.rst
<#3275 (comment)>:
> @@ -0,0 +1,252 @@
+.. title:: Learn
+
+.. raw:: html
+
+ <h1 class="ui header">Learn Bayesian statistics</h1>
+
+ <h2 class="ui header">...with others!</h2>
yep. we *could* do this from a configuration file or something, but I
think copy/pasting for each new book is fine.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#3275 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AApJmBBfHzCW3cvq92nkspMXbC0UD1Hsks5uzt8QgaJpZM4Y33uz>
.
|
Or we could cut a new release. |
I would definitely add this to the release-notes. @ColCarroll Anything in specific you want feedback on? Otherwise we can probably just merge this. |
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). |
It's a great improvement compare to our current doc, thanks for the hard work @ColCarroll! |
Should be all set. I also shuffled release notes a bit, since most folks are interpreting |
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:
layout.html
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!).