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
doc update #3958
doc update #3958
Conversation
significant differences from the latest stable release (0.13.2). | ||
This documentation is for a development version of IPython. | ||
In particular, it is for `Paul Ivanov's branch | ||
<https://github.com/ivanov/ipython>`_ |
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.
this changeset is one of the reasons this isn't ready to be merged - I will cherry pick it out...
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.
Just do it dynamically with something in conf.py :-)
Not too bad. |
In general, it's looking really great! Just browsed through quickly so far -- I like the style a lot, and it looks really good as rendered on "readthedocs". Can we switch to that CSS for the IPython docs? Of course, this isn't for 1.0, right? :P |
Believe me, it look nice at first glance, but you get tired of it in the end. |
@dpsanders you'll be able to view our docs via readthedocs now |
What happened to cell magics in https://ipypi.readthedocs.org/en/latest/interactive/notebook.html ? I see that you removed all of my careful distinction between the Notebook application and notebook documents... |
rendered natively by MathJax_. | ||
* In-browser editing for rich text using the Markdown_ markup language, which | ||
can provide commentary for the code | ||
, is not limited to plain text. |
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.
newline before comma
Various inline comments, but this is excellent. |
ok, added a redirect, this page now redirects to just notebook.html |
Cell magics aren't notebook specific, and were already documented here. |
@@ -67,7 +67,7 @@ The currently supported export formats are: | |||
* ``--to markdown`` | |||
|
|||
Simple markdown output. Markdown cells are unaffected, | |||
and code cells are placed in triple-backtick (``\`\`\```) blocks. | |||
and code cells are placed in triple-backtick (```````) blocks. |
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.
'counts back-tick apostrophes' 😑
Looking really good! Just two small things I commented on |
Ahh you beat me to it @takluyver |
ok gang, one last commit, before i squash these guys, just look at ivanov/ipython@140626e |
👍 Looks good to me after a quick read |
closes ipython#3902 incorporating doc changes from David Sanders, minor revisions my own -@ivanov
- added links to example notebooks on nbviewer - removde unnecessary file and parts of files - put old htmlnotebook.html redirect (for Notebook Help urls in 0.13.x) - moved working_remotely to public_server - re-arrangement of notebook connection stuff - more cross-referencing of documentation sections - made links to magic command explanation in tutorial - and many more changes...
doc update for 1.0
this started off innocently enough as a way to finish #3902.
Then I got a little crazy ;)
This isn't ready to be merged yet, I just wanted to put up what I have so far.
You can view a rendered version of this branch
here