Notebook docs touchup #3902
Notebook docs touchup #3902
Conversation
supposed to be a comment in the notebook docs
| @@ -563,7 +552,7 @@ on available options, use:: | |||
| :ref:`config_overview`, in particular :ref:`Profiles`. | |||
|
|
|||
|
|
|||
| Importing `.py` files | |||
| Importing ``.py` files | |||
…Added : to make config cross-link work
| @@ -98,20 +98,24 @@ and rich representations of objects. | |||
|
|
|||
| Notebooks may easily be exported to a range of static formats, including | |||
| HTML (for example, for blog posts), PDF and slide shows, | |||
| via the new nbconvert_ command. | |||
| via the new ``nbconvert`_ command. | |||
There was a problem hiding this comment.
Fixed.
There is a problem in nbconvert.rst in line 70, where it refers to "three
backticks",
but these are not rendered correctly in the final HTML.
I tried to fix it, but without success. Any ideas?
On Mon, Aug 5, 2013 at 7:07 AM, Matthias Bussonnier <
notifications@github.com> wrote:
In docs/source/interactive/notebook.rst:
@@ -98,20 +98,24 @@ and rich representations of objects.
Notebooks may easily be exported to a range of static formats, including
HTML (for example, for blog posts), PDF and slide shows,
-via the new nbconvert_ command.
+via the new ``nbconvert`_ command.missmatch backticks ?
—
Reply to this email directly or view it on GitHubhttps://github.com//pull/3902/files#r5577151
.
Dr. David P. Sanders
Profesor Titular "A" / Associate Professor
Departamento de Física, Facultad de Ciencias
Universidad Nacional Autónoma de México (UNAM)
dpsanders@gmail.com
http://sistemas.fciencias.unam.mx/~dsanders
Cubículo / office: #414, 4o. piso del Depto. de Física
Tel.: +52 55 5622 4965
|
Maybe one small comment. Otherwise looks great. |
|
Did you fixed the backticks ? you can make some live experiments here if needed. |
|
Got it, thanks! On Mon, Aug 5, 2013 at 7:38 AM, Matthias Bussonnier <
Dr. David P. Sanders Profesor Titular "A" / Associate Professor dpsanders@gmail.com Cubículo / office: #414, 4o. piso del Depto. de Física Tel.: +52 55 5622 4965 |
| ``Ctrl-m i`` interrupt kernel | ||
| ``Ctrl-m .`` restart kernel | ||
| ``Ctrl-m h`` show keyboard shortcuts | ||
| =============== ========================== |
There was a problem hiding this comment.
undo this change, monospace is not helpful here.
There was a problem hiding this comment.
Ignore me - it's better to be consistent, and monospace is the way keyboard shortcuts are done elsehwere. But it is best to use :kbd:Ctrl-m h`` for uniform formatting, rather than plain ````
… the end of notebook.rst and reworded the warning
|
I just moved the "roundtrip" warning to the end, in the section on importing .py. All comments now addressed; ready to merge. |
|
This looks good @dpsanders ! Thanks for all the help 👍 |
| a literate way, interleaving executable code with rich text, mathematics, | ||
| and rich representations of objects. | ||
| Notebook document files are simple JSON_ files with the extension ``.ipynb``. | ||
| Since JSON is just plain text, they can be easily version-controlled and |
There was a problem hiding this comment.
easy version-controlled? I don't think so... ;-)
There was a problem hiding this comment.
@damianavila Please explain? Because of the figures you mean?
There was a problem hiding this comment.
I mean that the you can not easily version-control the .ipynb files... you have to pre-process them to do it... for example, every time you run a cell, the input and output numbers change, so you can get the same notebook, I mean with the same content, but with differences between them... then, you have changes to commit that makes no sense... I hope to be enough clear... ;-)
|
Do you want to add a warning that running over http/without password is dangerous even on localhost if machine has multiple user accounts ? |
| @@ -58,7 +63,7 @@ the command:: | |||
| Your browser will warn you of a dangerous certificate because it is | |||
| self-signed. If you want to have a fully compliant certificate that will not | |||
| raise warnings, it is possible (but rather involved) to obtain one, | |||
| `as explained in detailed in this tutorial`__. | |||
| as explained in detailed in `this tutorial`__. | |||
There was a problem hiding this comment.
changes like these are not necessary
|
I fear that this is hardly a "touch up" of the docs anymore. @dpsanders can you squash these commits? it's getting quite a bit unruly. Please do not inlcude the non-functional changes (e.g. keep the htmlnotebook anchor as it was, or the link name change in |
|
Sure, please suggest the text to add and where to add it! On Tue, Aug 6, 2013 at 2:12 AM, Matthias Bussonnier <
Dr. David P. Sanders Profesor Titular "A" / Associate Professor dpsanders@gmail.com Cubículo / office: #414, 4o. piso del Depto. de Física Tel.: +52 55 5622 4965 |
|
@ivanov OK, I see what you mean. How do I "squash these commits"? |
|
in the security section, change |
|
As for squashing you should read that |
|
I've squashed an cherry-picked the functional changes in a local branch and will have a PR shortly that will close this one |
|
@ivanov Many thanks -- classes started again on Monday, and I have not had the time or mental energy to sit down and work out how to do this. Python-ing time will now be severely curtailed... but I'm planning to base my teaching around the IPython notebook, so you can expect bug reports and user interface complaints... |
closes ipython#3902 incorporating doc changes from David Sanders, minor revisions my own -@ivanov
Cleaning up outstanding issues in notebook.rst.