Commit Graph

176 Commits

Author SHA1 Message Date
Thomas Kluyver
17ba3079f8 Document pre/post save hooks
Using the examples from ipython/ipython#6896

Closes ipython/ipython#8599
2015-08-24 11:43:04 -07:00
Antonino Ingargiola
35f68601dc Typo 2015-08-24 09:57:34 -07:00
Antonino Ingargiola
8d7dba3f85 Spell check 2015-08-24 09:51:25 -07:00
Matthias Bussonnier
f9ad56e206 Add option to not use minified javascript and ease developpement. 2015-08-16 12:33:13 -07:00
Min RK
af44aeb31c add changelog 2015-08-13 22:14:57 -07:00
Thomas Kluyver
89c4defaf2 Miscellaneous doc updates and warning-squashing 2015-08-06 10:51:51 -07:00
Thomas Kluyver
b9c88fdf84 Add browser compatibility info
Moved from IPython docs
2015-08-06 10:38:25 -07:00
Min RK
26334946f9 Merge pull request #238 from takluyver/Carreau-icons
iconset for Jupyter notebook
2015-07-28 10:16:32 -07:00
Min RK
2218d7df95 Merge pull request #235 from takluyver/docs-mathjax
Fix up some issues with the Mathjax examples in the docs
2015-07-27 14:38:33 -07:00
Thomas Kluyver
884ef1dc28 Fix up some issues with the Mathjax examples in the docs
Fix the display of code samples in the Mathjax example doc, and squash
some warnings when building the docs.

This still doesn't make most of the examples display, because pandoc
makes the \begin{} & \end{} block into a raw latex block, which isn't
rendered in the HTML output. Not sure what to do about that.
2015-07-27 14:03:43 -07:00
Thomas Kluyver
72fa817fab Make 'extending' a directory in the docs 2015-07-27 13:41:18 -07:00
Scott Sanderson
e76548a96a MAINT: Simpler way of writing classes. 2015-07-25 19:10:26 -04:00
Scott Sanderson
0d70a84ef1 DOC: More notes on Contents API. 2015-07-25 19:10:26 -04:00
Scott Sanderson
7e720ab22b WIP: Moar docs. 2015-07-25 19:10:26 -04:00
Scott Sanderson
9e13c3b0cd DOC: Initial work on Contents API docs. 2015-07-25 19:10:26 -04:00
Thomas Kluyver
86ab103195 Remove docs on live-rebuilding CSS
We moved away from gulp.
2015-07-24 18:02:17 -07:00
Thomas Kluyver
96032f7ec1 Document installing the JS machinery 2015-07-24 18:01:48 -07:00
Matthias Bussonnier
688dc2c6e8 iconset for Jupyter notebook
The pngs could be generated from inkascape in a loop, though for reason X
or Y, inkscape 0.91 refuse it.

The command to generate the icns is

iconutil -c icns -o ipynb.icns ipynb.iconset

 - yes the folder have to be named icon.iconset, because apple
 - yes the file icon_111x111@2x.png is the same than icon_222x222.png
   but the @2x make a difference on retina screen, because apple

right now in **some conditions** the iconutils fails with out of memory.
we should try to pngcrush some images.
2015-07-16 17:02:15 -07:00
Sylvain Corlay
01a9dd8424 step-forward button 2015-07-13 00:43:38 -04:00
Jonathan Frederic
b19a4eab3f Update link 2015-06-19 12:49:37 -07:00
Jonathan Frederic
90fce8db85 Correct link 2015-06-19 12:48:47 -07:00
Jonathan Frederic
cc551ea657 Check in built rst 2015-06-18 14:08:59 -07:00
Jonathan Frederic
b41e33ae3a Add custom template to notebook conversion, which adds a nbviewer link, and corrects internotebook links. 2015-06-18 14:07:52 -07:00
Jonathan Frederic
5c05a0d720 Update index 2015-06-18 13:09:24 -07:00
Jonathan Frederic
a0e20c7706 Add ability to compile notebooks to restructured text. 2015-06-18 13:03:34 -07:00
Jonathan Frederic
4671bb9cb7 Moved example files into docs folder 2015-06-18 13:01:38 -07:00
Jonathan Frederic
07815b4ffc Remove wonky custom theme 2015-06-04 16:19:23 -07:00
Jonathan Frederic
a18acf52c8 @takluyver 's suggested changes. 2015-06-04 09:35:02 -07:00
Jonathan Frederic
4eb2db842b cwd->getcwd 2015-06-03 14:57:23 -07:00
Jonathan Frederic
79482e8b4f Add root 2015-06-03 14:46:43 -07:00
Jonathan Frederic
130d3d4779 Add requirements file for RTD 2015-06-02 17:30:56 -07:00
Jonathan Frederic
3716dd7328 Correct reference. 2015-06-02 15:35:01 -07:00
Jonathan Frederic
1e7c865cba Implement @takluyver's magic RTD executor 💀 2015-06-02 12:24:35 -07:00
Jonathan Frederic
38c6fffd8d Update jsdoc config. 2015-06-02 11:03:26 -07:00
Jonathan Frederic
af18367030 Remove profile info. 2015-06-02 08:26:23 -07:00
Jonathan Frederic
1ac315436b Update link to kernel install doc 2015-06-02 08:26:23 -07:00
Jonathan Frederic
0e10d87292 Implement @takluyver's doc generation API 2015-06-02 08:26:23 -07:00
Jonathan Frederic
bc2a2ecde2 Day 2 - rst 2015-06-02 08:24:17 -07:00
Jonathan Frederic
af5fbc5fc9 Day 1 2015-06-02 08:24:17 -07:00
Min RK
d71a59cc9f s/jupyter_notebook/notebook 2015-05-14 10:49:28 -07:00
Matthias Bussonnier
69d86dccc7 Configure watch/livereload extension and document it.
Is usefull mostly for css, but will be for typscript too.
2015-04-21 18:30:05 -07:00
stuntgoat
4366fa27b8 adding sphinx support 2015-04-21 15:37:14 -07:00
Jan Schulz
0ab4c36c00 Document how to install kernel spec files
Closes: #7988
2015-03-11 21:36:00 +01:00
onesandzeroes
39ada05675 Remove mention of previous behaviour 2015-03-06 08:55:06 +11:00
onesandzeroes
f61f8de555 Update info about latex/pdf conversion 2015-03-05 22:18:01 +11:00
Thomas Kluyver
99572b5e1a Merge pull request #7878 from minrk/nbconvert-downgrade
add downgrade example to whatsnew
2015-02-27 10:06:09 -08:00
Min RK
d0b57d7803 discuss --to notebook
- downgrade and execute examples
- also update `--to python` with `--to script`
2015-02-27 10:02:40 -08:00
Min RK
841c4907b1 remove old notebook format doc at the bottom of nbconvert doc
There is a much more complete doc of the nbformat now,
I didn't realize this was here, or I would have removed it when I added the new one.
2015-02-26 10:48:15 -08:00
Min RK
a380ccaec2 all new fields are backward-compatible
not just on cells, outputs, metadata
2015-01-24 12:10:09 -08:00
Min RK
5496010f0c describe what constitutes a minor revision to nbformat 2015-01-24 12:08:29 -08:00
Min RK
b23cd3d38e fix stream output specification in nbformat doc 2015-01-24 12:08:28 -08:00
Jonathan Frederic
1e0acbeb31 Write a plugin to handle private function automatically. 2014-12-12 12:43:57 -08:00
Jonathan Frederic
d756816e2b Some typo fixes 2014-12-12 12:43:57 -08:00
Jonathan Frederic
c46ae2e637 Markdown support. 2014-12-12 12:43:57 -08:00
Jonathan Frederic
0f2da9aa07 Finish implementing JSDoc support 2014-12-12 12:43:56 -08:00
Jonathan Frederic
1aa280d9c9 Start JSDoc integration 2014-12-12 12:43:56 -08:00
Min RK
7dcb61b787 add language_info to nbformat doc and spec 2014-11-24 11:55:22 -08:00
Reggie Pierce
ffd5081485 Fixed port range
Actual port range for ZMQ is 49152 through 65535.  Also fixed some grammar/spelling issues.
2014-11-18 11:22:46 -05:00
Reggie Pierce
9dee257185 Public server firewall configuration
Added section on firewall configuration.  This should prevent users (like me) from struggling
to figure out why their servers aren't executing code.
2014-11-18 08:56:29 -05:00
Min RK
a33a7f04e1 note about mime-bundle in nbformat doc 2014-11-01 16:41:13 -07:00
MinRK
7bf5a9d2ee fix gender on Jupyter
My French is weak.
2014-11-01 16:41:12 -07:00
MinRK
ae0b46aa3f address review from takluyver
- various typos
- discuss multi-line strings in nbformat doc
- testing cleanup
- py3compat simplification
- don't use setdefault when composing notebook nodes
- mime-type fix in svg2pdf
2014-11-01 16:41:09 -07:00
MinRK
c57a43feac add metadata tables to nbformat doc 2014-11-01 16:41:08 -07:00
MinRK
dd95b1ef5f remove heading cells in v4 2014-11-01 16:41:07 -07:00
MinRK
12e0223ed7 update nbformat spec in sphinx 2014-11-01 16:41:06 -07:00
MinRK
fc47201cc7 add nbformat spec to sphinx 2014-11-01 16:41:03 -07:00
MinRK
caddaec618 remove references to kernel config in parent config files
since it doesn't work anymore.
Link to the kernel config doc instead.
2014-09-28 12:54:08 -07:00
MinRK
979ef8257d add some documentation notes about trust being per-profile 2014-07-07 14:56:00 -05:00
John Zwinck
1be538a945 Fix typo in docs 2014-06-24 15:09:51 +08:00
Mohan Raj Rajamanickam
0f0ae3f3d9 Update notebook.rst
Updating broken reference to notebook examples 

Since the notebook directory doesn't contain a readme anymore, updating to point to the index notebook rendered via nbviewer
2014-04-21 16:56:52 -07:00
Thomas Kluyver
7136cffe1f Remove the outdated keyboard shortcuts from notebook docs
Closes gh-5569

Backport to 2.x.
2014-04-09 17:36:15 -07:00
Thomas Kluyver
f1e615cbf8 Disambiguate conflicting label 2014-04-02 10:11:12 -07:00
Thomas Kluyver
6e5b4c88a4 Remove link to nonexistent doc 2014-04-02 10:10:59 -07:00
MinRK
5834d17153 review pass on what's new in 2.0 2014-04-01 21:52:33 -07:00
Paul Ivanov
7d4aed19e8 remove cm_keyboard.rst and OS-level shortcuts 2014-03-28 17:01:32 -07:00
MinRK
97565e3771 move PGP key to download link 2014-03-25 14:40:55 -07:00
MinRK
76424aff09 fix now-confusing section name in public server doc 2014-03-25 13:10:51 -07:00
MinRK
b9c5eec22f move notebook docs to source/notebook 2014-03-25 13:09:26 -07:00
MinRK
322c6431b8 add ipython_security public key 2014-03-25 12:57:50 -07:00
MinRK
bb06f92705 add notebook security doc 2014-03-25 12:57:41 -07:00
Paul Ivanov
ac7b13fd12 fix docs, closes #5345 2014-03-20 00:38:02 -07:00
Brian E. Granger
db4960769b Merge pull request #5100 from minrk/base_kernel_url
remove base_kernel_url
2014-02-20 17:00:38 -08:00
Kyle Kelley
feccfa7823 Add pointers to simple nb manager and bookstore. 2014-02-13 10:16:13 -07:00
Kyle Kelley
c9adc812bf Remove remaining refs to the Azure NB Manager 2014-02-12 14:18:04 -07:00
MinRK
a184724bdb remove base_kernel_url 2014-02-11 21:26:10 -08:00
MinRK
542e9223e7 add notebook signing docs 2014-01-29 14:37:01 -08:00
damianavila
f308b12721 Deleted jargon-ish reference to no-connectity. 2014-01-07 17:17:03 -03:00
damianavila
78e41cd766 It is the serve post processor and not the way to specify it. 2014-01-06 16:37:33 -03:00
damianavila
1838cc2d82 Added --post-serve explanation into the nbconvert docs. 2013-12-30 14:45:15 -03:00
damianavila
4845ec9582 Documenting codemirror shorcuts. 2013-11-24 17:20:09 -03:00
Thomas Kluyver
ed281bacb4 Miscellaneous doc fixes 2013-11-01 19:14:09 -07:00
MinRK
0af45c4694 update reveal docs with recent changes 2013-09-13 11:16:04 -07:00
MinRK
398a2d1da3 update nbconvert docs about reveal.js 2013-09-04 16:40:26 -07:00
Min RK
f69fceb1c8 Merge pull request #4147 from kermit666/patch-1
Reference notebook examples in docs.
2013-09-03 16:30:35 -07:00
Dražen Lučanin
7d9b220417 Reference notebook examples, fixes #4146. 2013-09-01 19:16:52 +02:00
Brian E. Granger
fdc32d54a8 Merge pull request #4090 from ellisonbg/citation
Add LaTeX citation handling to nbconvert
2013-08-30 16:40:00 -07:00
MinRK
d8eebfe3b7 unwrap openssl line in public_server doc
was inappropriately hard-wrapped, potentially causing bad copy/paste
2013-08-29 15:29:40 -07:00
Brian E. Granger
779b4cc83b Adding docs about latex citations. 2013-08-21 14:19:17 -07:00
Matthias Bussonnier
44e0d28345 Merge pull request #3863 from damianavila/speaker_notes
Added working speaker notes for slides.

To resume, I fetch the cdn containing the files we need to make speaker notes works. Then I pass this info using the resources dict to the write which output the files in the correct path...
I make some other additions to make this feature an option from the command line, ie:

if you want a simple slideshow:
ipython nbconvert your_slides.ipynb --to slides

if you want a simple served slideshow:
ipython nbconvert your_slides.ipynb --to slides --post serve

if you want to use a local copy of the reveal.js library:
ipython nbconvert your_slides.ipynb --to slides --post serve --local reveal.js

and if you want to use speaker notes:
ipython nbconvert your_slides.ipynb --to slides --post serve --notes True
or
ipython nbconvert your_slides.ipynb --to slides --post serve --notes True --local reveal.js 
but this last one is redundant because if you are using a local reveal.js library the speaker notes are functional by default.
2013-08-16 00:50:34 -07:00
damianavila
5a3414ff52 Fixed doc about using PR-related aliases. 2013-08-13 14:18:47 -03:00