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

doc update #3958

Merged
merged 2 commits into from Aug 9, 2013
Merged

doc update #3958

merged 2 commits into from Aug 9, 2013

Conversation

ivanov
Copy link
Member

@ivanov ivanov commented Aug 8, 2013

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

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>`_
Copy link
Member Author

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...

Copy link
Member

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 :-)

@Carreau
Copy link
Member

Carreau commented Aug 8, 2013

Not too bad.

@dpsanders
Copy link
Contributor

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

@Carreau
Copy link
Member

Carreau commented Aug 8, 2013

Can we switch to that CSS for the IPython docs?

Believe me, it look nice at first glance, but you get tired of it in the end.

@ivanov
Copy link
Member Author

ivanov commented Aug 8, 2013

@dpsanders you'll be able to view our docs via readthedocs now

@dpsanders
Copy link
Contributor

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.
Copy link
Member

Choose a reason for hiding this comment

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

newline before comma

@minrk
Copy link
Member

minrk commented Aug 8, 2013

Various inline comments, but this is excellent.

@ivanov
Copy link
Member Author

ivanov commented Aug 8, 2013

ok, added a redirect, this page now redirects to just notebook.html

@ivanov
Copy link
Member Author

ivanov commented Aug 8, 2013

What happened to cell magics in https://ipypi.readthedocs.org/en/latest/interactive/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.
Copy link
Member

Choose a reason for hiding this comment

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

'counts back-tick apostrophes' 😑

@jdfreder
Copy link
Member

jdfreder commented Aug 8, 2013

Looking really good! Just two small things I commented on

@jdfreder
Copy link
Member

jdfreder commented Aug 8, 2013

Correct link

Ahh you beat me to it @takluyver

@ivanov
Copy link
Member Author

ivanov commented Aug 9, 2013

ok gang, one last commit, before i squash these guys, just look at ivanov/ipython@140626e

@jdfreder
Copy link
Member

jdfreder commented Aug 9, 2013

👍 Looks good to me after a quick read

dpsanders and others added 2 commits August 8, 2013 17:41
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...
minrk added a commit that referenced this pull request Aug 9, 2013
@minrk minrk merged commit c2b47c8 into ipython:master Aug 9, 2013
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
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.

None yet

6 participants