Commit Graph

470 Commits

Author SHA1 Message Date
Matthias Geier
ac89707ecc DOC: Trying to make a single place for contributor docs
See #1193.
2016-03-14 20:21:27 +01:00
Nicholas Bollweg
d54ed564af initial crack at documentation for new-wave extension stuff 2016-03-10 13:44:50 -05:00
Jonathan Frederic
508804153a Remove ignore minified 2016-02-22 07:30:55 -08:00
joonnifer
c53badb454 Removed misplaced docs 2016-02-20 14:30:11 -06:00
Carol Willing
21788a58db Add pip to conda yaml for docs 2016-02-11 17:56:56 -08:00
Carol Willing
b4dbf5f5c2 Add a make spelling option for doc builds 2016-02-10 13:20:31 -08:00
Carol Willing
6fe7c7acbc Fix typos in development 2016-02-10 06:16:09 -08:00
Carol Willing
5c886a3734 Merge pull request #1063 from minrk/csp-doc
document CSP for iframes
2016-02-09 01:45:54 -08:00
Min RK
bd42e36fd6 document CSP for iframes 2016-02-09 09:01:07 +01:00
Min RK
247fc7d21d Revisions to js dev doc
- use `pip install -e .`
- clarify that `setup.py js css` is only needed for intermediate updates, not first-run
2016-02-08 13:35:01 +01:00
Min RK
621822b1de setting static_url_prefix isn't required for custom prefix 2016-02-08 13:09:40 +01:00
Min RK
a7fc604365 Merge pull request #1039 from willingc/devinstall
Organize contributor/developer documentation sections
2016-02-05 11:41:20 +01:00
Carol Willing
7d04e76e05 Fix image urls 2016-02-04 13:02:03 -08:00
Carol Willing
2eb578ecb5 Decrease toc depth and highlight general contribution docs 2016-02-02 13:06:03 -08:00
Carol Willing
d3f6292d0c Clean up section TOC 2016-02-02 11:39:36 -08:00
Carol Willing
836afb96fa Add intro doc and update toc 2016-02-02 10:12:53 -08:00
Carol Willing
e8fae5460f Rename file for consistency 2016-02-02 10:06:48 -08:00
Carol Willing
d101f6e637 Edits to formatting 2016-02-02 09:26:31 -08:00
Carol Willing
7999c738c4 Edit javascript machinery install 2016-02-02 08:49:29 -08:00
Carol Willing
71689275f1 Split dev doc and update index 2016-02-02 08:26:09 -08:00
Carol Willing
384d1760b0 Add dev install code snippet to docs 2016-02-02 06:31:29 -08:00
Min RK
eb5610c77b don't install on RTD
add repo to sys.path instead
2016-01-29 21:20:58 +01:00
Thomas Kluyver
85b49fcb90 Ensure that conda 1.3 is installed 2016-01-27 18:03:11 +00:00
Thomas Kluyver
0c39bf2848 Remove requirements.txt file for docs 2016-01-27 17:08:31 +00:00
Thomas Kluyver
3163d46d2d Use conda on Readthedocs 2016-01-27 17:06:40 +00:00
Carol Willing
4440077584 Add gif to docs for notebook creation 2016-01-19 09:05:30 -08:00
Min RK
82fb153329 Merge pull request #936 from Carreau/release-instructions
update release instruction a bit again
2016-01-09 12:16:50 +01:00
Carol Willing
d2ba5b10c8 Update doc for 4.1 announcement 2016-01-08 14:43:38 -08:00
Carol Willing
02b5f46208 Add backticks to fix typos 2016-01-08 14:15:17 -08:00
Matthias Bussonnier
5f31251b29 update release instruction a bit again 2016-01-08 18:48:27 +01:00
Steve Holden
2617931dbd Fix "an Jupyter" changes
Fixes problems noted in issue #926
2016-01-05 18:03:45 +00:00
Carol Willing
b410df0032 Merge pull request #907 from captainsafia/add-interface-desc-talks
Add information about names of UI element to docs
2016-01-04 16:01:20 -08:00
Safia Abdalla
9b01b0a757 Addressed PR comments 2016-01-04 16:15:17 -06:00
anirudhjoshi
eb2764bbad Fixed missing import of to_api_path in example 2016-01-04 11:06:18 +11:00
Safia Abdalla
0ec51645a4 Updated table of contents 2015-12-31 19:18:40 -06:00
Safia Abdalla
66aa256a69 Added UI components page 2015-12-31 19:18:26 -06:00
Safia Abdalla
b9a9b0d613 Added user interface screenshots 2015-12-31 19:16:51 -06:00
Safia Abdalla
a5de8f2502 Added initial annotated image 2015-12-29 14:50:47 -06:00
Carol Willing
69cd493201 Remove cute birds from screenshot 2015-12-28 09:47:57 -08:00
Carol Willing
187adf1a2e Fix typos and image size 2015-12-28 07:43:04 -08:00
Carol Willing
3a8a5963ff Add graphic of notebook 2015-12-28 07:43:03 -08:00
Fernando Perez
1c2905eb25 Update Notebook examples to current form of edit/command mode area look.
Update screenshots and area description to match that of keyboard help page.
2015-12-27 19:29:02 -08:00
Min RK
d1d81f8015 get package version for docs
so we don't need to manually update version strings
2015-12-22 14:05:25 +01:00
Carol Willing
7346b4c5bc Correct link 2015-12-22 04:45:26 -08:00
Carol Willing
35f7e52162 Update for 4.1.0rc1 and add FAQ 2015-12-22 04:34:50 -08:00
Min RK
4f8a15bfc8 include both sdist formats 2015-12-18 16:48:55 +01:00
Min RK
f8ede57918 add clear_output option to set_next_input payload
default preserves prior behavior
2015-12-15 14:41:36 +01:00
Min RK
98e40d7e12 Note set_next_input change in changelog 2015-12-15 14:34:14 +01:00
Peter Parente
472338ee7a Typo and wording fixes to 4.1 changelog sections
(c) Copyright IBM Corp. 2015
2015-12-15 07:51:15 -05:00
Peter Parente
f27c5c8a38 Additional changelog updates for 4.1
* Grammar consistency
* More details about how users trigger new features
* Screenshot of new location of cell toolbar triggers
* Couple more "other improvements"
* Links to PR and issue lists in the 4.1 milestone on GitHub

(c) Copyright IBM Corp. 2015
2015-12-15 07:51:15 -05:00
Carol Willing
1daafbf6f8 Add sidebar box in doc's index for 4.1.x 2015-12-14 20:15:48 -08:00
Matthias Bussonnier
d5e5383639 Merge pull request #867 from Carreau/quickselector
Update warning in the docs about quick selection.
2015-12-14 18:03:42 +01:00
Matthias Bussonnier
da5cbb53e6 Update warning in the docs about quick selection.
We could still refine the quick-selector to show the
type of the cell when all cells have the same type.

Fixes gh-861
2015-12-14 16:12:03 +01:00
Matthias Bussonnier
254c0a2307 Fix various comment and spelling 2015-12-14 10:46:35 +01:00
Matthias Bussonnier
11833724ac Update release instructions 2015-12-14 10:46:34 +01:00
Matthias Bussonnier
c7c9cec592 "Available" has only one "l" 2015-12-14 10:46:34 +01:00
Matthias Bussonnier
1ec3f5eeeb remove universal 2015-12-14 10:46:34 +01:00
Matthias Bussonnier
df32201009 Add release instructions 2015-12-14 10:46:34 +01:00
Carol Willing
f5856926d6 Correct google group link 2015-12-13 21:32:36 -08:00
Carol Willing
eb25904517 Add Stack Overflow @takluyver suggestion 2015-12-13 15:31:27 -08:00
Carol Willing
361e53fb2f Minor edit 2015-12-13 14:20:07 -08:00
Carol Willing
dee12240ab Make heading for installing Javascript in doc appear in contents 2015-12-13 14:11:15 -08:00
Carol Willing
265810d4f5 Add contact info more prominently on sidebar and in contents 2015-12-13 13:53:54 -08:00
Carol Willing
405d0bdeb7 Improve message about https in public server doc 2015-12-11 10:53:10 -08:00
Jonathan Frederic
193202bdb5 Copy edit 2015-12-10 09:33:53 -08:00
Matthias Bussonnier
225bbcffa7 Document limitation of quick celltype selector...
... With regard to Multiple selection.

Closes #805
2015-12-10 13:56:43 +01:00
Min RK
8024000a0e regen rst notebooks
with pandoc-1.15.2.1

fixes some heading inconsistencies
2015-12-04 13:36:30 +01:00
Min RK
1bbeb54673 rst can't handle arbitrary heading levels 2015-12-04 13:36:30 +01:00
Min RK
dfc51fae35 don't mention profiles in nbextensions 2015-12-04 13:36:30 +01:00
Min RK
5bbab29286 update 4.1 changelog
with screenshots of new UI
2015-12-04 13:36:30 +01:00
Josh Barnes
9e9828f624 in docs/extending/frontend_extensions:
* fix 'the' typo
2015-12-01 15:57:54 +00:00
Josh Barnes
99f6379f14 in docs/extending/frontend_extensions:
* Add some description of actions
2015-12-01 13:54:21 +00:00
Josh Barnes
71f5a1969e in docs/extending/frontend_extensions:
* fix AMD link to use RST syntax (mistakenly used markdown previously)
2015-12-01 13:54:21 +00:00
Josh Barnes
bf44aace54 in docs/extending/frontend_extensions:
* fix inline literals, which in RST start and end with ``, not just `
2015-12-01 13:54:20 +00:00
Josh Barnes
ad7e657e5c in docs/extending/frontend_extensions:
* beautify javascript examples
* make one-liners fit on one line
2015-12-01 13:54:18 +00:00
Josh Barnes
67c6aaafae in docs/extending/frontend_extensions:
* fix some typos & misspellings
* some improvements to phrasing
2015-12-01 12:23:48 +00:00
Matthias Bussonnier
66f7390f8d missing N 2015-12-01 10:27:36 +01:00
Thomas Kluyver
92caca5683 English fixes and update description of installing and activating extensions 2015-11-30 18:26:25 +00:00
Matthias Bussonnier
1feb3960d8 Start documenting how to write font end extension
This if course require more work, but the request for custom key binding
is too high, and the process of writing extensions too widespread on the
internet.
2015-11-25 19:22:10 +01:00
Min RK
f998bd67df Merge pull request #732 from Carreau/docs
Fix docs on secure server.
2015-11-20 20:19:33 +01:00
Matthias Bussonnier
5c73284c39 Fix docs on secure server. 2015-11-17 16:44:32 -08:00
Brett Cannon
97071b74ff Fix a dead link to example notebooks 2015-11-17 12:05:29 -08:00
Matthias Bussonnier
1a63c0397e Update text with willinc version 2015-10-29 16:43:09 -07:00
Matthias Bussonnier
9852b654f4 'update docs' 2015-10-29 16:11:08 -07:00
Min RK
bd6916199f add missing keyfile arg to ssl doc 2015-10-28 10:37:50 +01:00
Jonathan Frederic
4ae2f829f3 @willingc's comment 2015-10-26 09:51:41 -07:00
Jonathan Frederic
0d3729a03b Update the changelog 2015-10-26 08:53:16 -07:00
Brian E. Granger
dab9765e42 Fixing one last misnaming. 2015-10-21 09:35:05 -04:00
Brian E. Granger
c7d3728b6e Renaming jupyter-notebook -> jp-notebook 2015-10-19 14:29:48 -04:00
Brian E. Granger
33bcdf907d Fixing tests and example notebook 2015-10-19 14:29:48 -04:00
Brian E. Granger
7df94eb001 Renaming commands 2015-10-19 14:29:48 -04:00
Daniel Darabos
1d1838284a Fix typo in the RST version too. 2015-10-15 14:27:52 +02:00
Daniel Darabos
1b51230e8b Fix typo in What is the Jupyter Notebook. 2015-10-15 14:26:10 +02:00
Min RK
ee2addb7fc note changes in 4.0.6 2015-10-15 09:45:22 +02:00
John Kirkham
ab7464bf5a docs/source/changelog.rst: Note what we did. 2015-10-08 00:47:02 -04:00
Min RK
36fa064cac Merge pull request #508 from jdfreder/handlerdoc
Custom server request handler, docs
2015-10-03 16:46:27 +02:00
Jonathan Frederic
c5553ca4fa Whitespace sensitive language 2015-10-01 00:12:14 -04:00
Jonathan Frederic
a54ded224e Conver to RST 2015-09-29 15:44:25 -04:00
Jonathan Frederic
a5215f3027 Add handler doc 2015-09-29 15:34:17 -04:00
Carol Willing
004a96298e Add navigation to Jupyter Installation docs 2015-09-26 08:10:31 -07:00
Carol Willing
ac59eb343a Add generated notebooks rst files to version control 2015-09-24 15:16:38 -07:00
Carol Willing
808776f4a4 Add Jupyter to docs requirements 2015-09-24 11:47:19 -07:00
Min RK
7a197feb33 Merge pull request #477 from minrk/cves
note CVEs in 4.0.5 release notes
2015-09-24 15:28:58 +02:00
Min RK
777fb2f7cd Merge pull request #481 from willingc/doc-frontend
Add notebook frontend configuration doc
2015-09-24 15:15:22 +02:00
Min RK
e3bd496b54 note CVEs in 4.0.5 2015-09-24 12:00:53 +02:00
Carol Willing
786a350527 Fix grammar from review comments 2015-09-23 22:43:26 -07:00
Carol Willing
364e8fe2e0 Minor edits 2015-09-23 22:38:43 -07:00
Carol Willing
126c77c833 Update config docs 2015-09-23 22:38:43 -07:00
Carol Willing
61a5382083 Add frontend configuration doc 2015-09-23 22:38:43 -07:00
Carol Willing
bfdd0a2e51 Add empty _static folder 2015-09-23 18:42:31 -07:00
Carol Willing
d05835a5d1 Update toc for rst build from ipynb 2015-09-23 18:02:29 -07:00
Carol Willing
c541cb4125 Add index for generated rst from ipynb 2015-09-23 17:32:17 -07:00
Carol Willing
b0b8a2f71c Remove examples index 2015-09-23 16:28:00 -07:00
Carol Willing
5216bc6143 Update index 2015-09-23 16:27:10 -07:00
Carol Willing
6eb519916d Update index 2015-09-23 14:35:06 -07:00
Carol Willing
453f2ce30b Update rtd configs 2015-09-23 13:56:51 -07:00
Karrie Kehoe
2090c0b000 Update JavaScript Notebook Extensions.ipynb 2015-09-23 15:39:55 +01:00
Matt McCormick
ac43d7fec8 Document Docker CMD kernel crashing issue.
Add issue #334 to the known issues and suggest a work-around with tini
init.
2015-09-22 18:28:53 -04:00
Antonino Ingargiola
418469d81d Docs: small metadata changes 2015-09-22 08:45:18 -07:00
Antonino Ingargiola
dc16502fd1 Docs: remove outdated info on notebook headings. 2015-09-22 08:44:24 -07:00
Matthias Bussonnier
c9a9b5b50e don't overwrite file
closes https://github.com/ipython/ipython/issues/8796
2015-09-21 11:22:27 -07:00
Carol Willing
1fb22882e7 Edit see also box in doc 2015-09-20 22:28:41 -07:00
Carol Willing
cb9961a030 Add comment for future devs 2015-09-20 20:55:21 -07:00
Carol Willing
65224302de Revert html_static_path setting 2015-09-20 20:33:42 -07:00
Carol Willing
687e844fb3 Update doc index with captions 2015-09-18 05:25:45 -07:00
Min RK
dce01c0695 Merge pull request #459 from willingc/del-ipynb
Remove the duplicate ipynb for public server doc
2015-09-18 14:15:55 +02:00
Carol Willing
956509029e Remove ipynb and update indices 2015-09-18 05:02:26 -07:00
Carol Willing
ea6993703e Add review changes to public server doc 2015-09-18 03:22:43 -07:00
Carol Willing
88554a003e Fix formatting on ipynb note 2015-09-16 15:40:27 -07:00
Carol Willing
64ae031488 Add note and link to RTD in old ipynb doc 2015-09-16 15:34:22 -07:00
Carol Willing
ce6ecb730b Edit content on running a public notebook server 2015-09-16 15:14:55 -07:00
Carol Willing
de9781dcba Update doc on securing a notebook server 2015-09-16 15:14:55 -07:00
Carol Willing
2179be6843 Edit public server security doc 2015-09-16 15:14:55 -07:00
Carol Willing
67740f8014 Fix small docs errors and add hidden index for clean doc builds 2015-09-16 10:45:30 -07:00
juan serrano
f9280708b2 Add examples of latex expressions 2015-09-12 04:02:34 -07:00
Matthias Bussonnier
c29b8780a3 update shortcut 2015-09-08 09:11:49 -07:00
Matthias Bussonnier
2189b7f686 Merge pull request #363 from Carreau/docs-typo
Docs typo
2015-09-03 11:16:19 +02:00
Matthias Bussonnier
eeb9573991 bring more fixes 2015-09-02 15:12:04 +02:00
Matthias Bussonnier
552fd197d5 port some typos 2015-09-02 15:03:26 +02:00
Matthias Bussonnier
98745984c2 Remove auto generate .rst files 2015-09-02 15:03:24 +02:00
Matthias Bussonnier
de925603e4 move typo from rst to ipynb 2015-09-02 15:03:02 +02:00
jslmann
5f2dea1c8e superficial english fixes
because I appreciate your work, and was bored..
2015-09-02 15:02:58 +02:00
Matthias Bussonnier
06da70c536 Remove unused logo 2015-09-01 14:28:59 +02:00
A-level (hey)
c640d682fd Update JavaScript Notebook Extensions.rst
Hey, I was just reading the docs to better understand the internals. This doc is really informative and interesting and I love the conversational writing style! I hope you don't mind, I made a few quick ten minute proofs/edits. My only question is if this rst doc is the right place to make the edits to populate the ipynb file? Thanks.
2015-08-31 18:49:54 +02:00
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
Paul Ivanov
92ed491c12 major doc update for 1.0 release
- 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...
2013-08-08 17:41:51 -07:00
David P. Sanders
8897c39731 notebook docs touchup
closes #3902

incorporating doc changes from David Sanders, minor revisions my own

-@ivanov
2013-08-08 17:41:51 -07:00
damianavila
e77906e213 Fixing names for aliases. 2013-08-02 17:58:44 -03:00
Paul Ivanov
9a5d83b017 add keyboard shortcut to docs, closes #2960 2013-07-31 22:49:16 -07:00
damianavila
ba701557f3 Fixing docs. 2013-07-31 20:12:28 -03:00
damianavila
2894b267b5 Added working speaker notes for slides. 2013-07-31 19:55:08 -03:00