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
Restructure docs #3303
Restructure docs #3303
Conversation
This looks like a good suggestion to me -- thanks for the well written issue and for making the this pull request! Once you are ready for detailed comments on this PR, I can build them on my machine and push them to a static site so we can try them live - please put a comment here letting me know! A few responses to your points:
|
If rest of the @pymc-devs chime into an agreement I can make the necessary changes. |
|
Details ------- Quickstart = API quickstart (no navbar link, linked big blue button + tutorials) Learn -> Books+Videos Quickstart(old) -> About PyMC3 * Added syntax highlighting to landing page code snippet * Added see also section at the end of About PyMC3 * Classified Tutorials into Basic and How-Tos
See updated look here: #3301 (comment) |
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.
LGTM. @ColCarroll could you please build it offline on your website so we can see how it looks?
@@ -190,3 +191,6 @@ pseudoxml: | |||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | |||
@echo | |||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." | |||
|
|||
serve: html |
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 don't think http.server
actually takes a --directory
argument! (only confirmed on python 3.6.6)
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.
Hmm. Maybe they introduced it on python 3.7+. I will swap that with a simple cd
.
Pushing to my site: https://colindcarroll.com/static/pymc3/ Note as before that absolute links don't work, but relative ones do (so the pymc3 logo takes you to my homepage). Only nitpick is the empty "Other" section on the bottom of the "Tutorials" page. I did not take a close look at the Thanks again, @ashwinvis! |
Final nitpick:
|
The dangling "Other" section is javascript stuff, no guarantees, but I can have look at it. Will fix the rest for sure. |
Backwards compatible `make serve`, no dangling "Other", "intro.rst" -> "history"
Thanks for the quick code reviews. This PR was a thank you gesture for helping me implement monte-carlo for a climate sensitivity exercise. Cheers 🎉 |
This looks great! |
Great work @ashwinvis !!! |
* [WIP] Restructure docs.pymc.io, add developer guide Following #3303, this is a further restructure of our website. - Tutorial page include all our high level API guides (including theano.rst, prod_dist.rst, gp.rst etc) - renaming of some notebooks (some of them does not have title) - notebooks might appear under more than 1 categories (if it covers multiple topics) * Further formatting * Add developer guide * edit developer guide * small formatting * further formatting * final formatting * really final formatting * fix links * small edit + another proof reading * formatting
* [WIP] Restructure docs.pymc.io, add developer guide Following #3303, this is a further restructure of our website. - Tutorial page include all our high level API guides (including theano.rst, prod_dist.rst, gp.rst etc) - renaming of some notebooks (some of them does not have title) - notebooks might appear under more than 1 categories (if it covers multiple topics) * Further formatting * Add developer guide * edit developer guide * small formatting * further formatting * final formatting * really final formatting * fix links * small edit + another proof reading * formatting
Work in progress to fix #3301, suggestions welcome.
What has changed