Commit Graph

470 Commits

Author SHA1 Message Date
Carol Willing
f84bb09fec Add letsencrypt instructions re: Pollock on ML 2016-05-02 15:16:26 -07:00
Daniel McDonald
69ab463a0e Missing newline impacting RTD rendering
Please see the attached screenshot.
2016-04-15 16:03:55 -07:00
Carol Willing
12ee0ec86a Update changelog and remove what's new 2016-04-12 13:03:08 +02:00
Min RK
43165c942c changelog for 4.2.0
forward-port from 4.x branch
2016-04-11 20:51:05 +02:00
Carol Willing
788e8b696c Fix typo 2016-04-06 17:42:25 -07:00
Carol Willing
898370ef2b Add a configuration overview 2016-04-06 17:33:15 -07:00
Carol Willing
a3ac1d8aa1 Add a configuration overview page to help with topic discoverability 2016-04-06 17:33:15 -07:00
Carol Willing
7e1e1344d7 Remove custom.css from docs 2016-04-05 19:43:00 -07:00
Carol Willing
cff713abe1 Remove html_context from sphinx conf 2016-04-05 19:32:56 -07:00
Matthias Bussonnier
cbd9708f1b Merge pull request #1266 from mgeier/nbsphinx-tuning
Minor nbsphinx-related tuning
2016-04-05 10:45:13 -07:00
Matthias Geier
9c56f4577d Avoid !important in CSS 2016-03-30 14:21:46 +02:00
Steven Silvester
1d32e7cdac Update link to swatter docs 2016-03-29 14:59:49 -07:00
Carol Willing
b0d09aa3cc Set sphinx build <1.4 since new sphinx and latex unhappy 2016-03-29 05:38:53 -07:00
Matthias Geier
7a14d1c55e Remove "rstversions" from one last link 2016-03-26 17:28:50 +01:00
Matthias Geier
e11445b184 Fix nbviewer link 2016-03-26 16:44:07 +01:00
Matthias Geier
b3788c283f Add custom.css 2016-03-26 14:34:12 +01:00
Matthias Geier
3cdc082ab2 Ignore .ipynb_checkpoints/ when building docs 2016-03-26 14:28:58 +01:00
Matthias Geier
4d4dbc7b95 DOC Makefile: Remove ipynb2rst from phony targets 2016-03-26 14:14:02 +01:00
Min RK
41d6da235c Merge pull request #879 from ellisonbg/nbext-pain
New nbextensions installation API
2016-03-25 22:02:22 -07:00
Carol Willing
a52773e2ca Rename requirements for docs and remove spelling packages 2016-03-24 15:07:51 -07:00
Carol Willing
f10a045e68 Merge pull request #1208 from mgeier/devel-docs
DOC: Trying to make a single place for contributor docs
Closes #1193
2016-03-24 14:48:44 -07:00
Matthias Geier
69b09b5af0 Add instructions for getting the doc-building requirements
... and add docs/requirements.txt
2016-03-24 18:48:23 +01:00
Min RK
6371f8aec2 add --system flag for enable/disable
add more docs coverage, help output

So that the three cases are covered:

- system-wide (default for install)
- user (default for enable)
- sys-prefix
2016-03-24 15:23:32 +01:00
Min RK
1287c86c8b Remove incorrect mention of --user in docs
enable is user by default
2016-03-24 15:21:33 +01:00
Min RK
212d517a92 Merge pull request #1234 from Carreau:keyb
Make keyboard shortcuts declarative
2016-03-24 12:59:12 +01:00
Carol Willing
f552645623 Try to fix Rogers-Ramanujan Identity display 2016-03-23 20:49:22 -07:00
Carol Willing
5748c04ed6 $ for math doc win 2016-03-23 20:26:29 -07:00
Carol Willing
b70cd1016e Added $ for mathjax 2016-03-23 20:18:52 -07:00
Carol Willing
a31ba88372 Try Prof. Willie Wong's code snippet 2016-03-23 19:59:06 -07:00
Carol Willing
97640668bd Fix typo 2016-03-23 19:38:06 -07:00
Carol Willing
48566ce93a Add link to nbviewer at the top of the rst index 2016-03-23 19:33:13 -07:00
Carol Willing
a31ba24056 Drop H1 to H2 in markdown 2016-03-23 19:26:26 -07:00
Carol Willing
2cd031e51a Use rst for index 2016-03-23 19:23:38 -07:00
Carol Willing
6f42d8e8e7 Fix some links 2016-03-23 19:22:57 -07:00
Carol Willing
8900709a8b Save notebook as py3 2016-03-23 19:22:57 -07:00
Carol Willing
da4b034d45 Add nbsphinx to conda yaml
Update the conda_env yaml
Update environment
2016-03-23 19:22:10 -07:00
Carol Willing
4f13fa7a9c Tweak notebooks for build
Fix other.ipynb notebook
Add notebook still one warning
2016-03-23 19:21:34 -07:00
Carol Willing
a13bff8850 Add frontend doc 2016-03-23 19:21:33 -07:00
Carol Willing
dfafaef668 Update TOC 2016-03-23 19:21:33 -07:00
Carol Willing
4a0342b973 Update the nodebook so a cell doesn't cause a segfault intentionally 2016-03-23 19:21:33 -07:00
Carol Willing
c20212772c Update makefile and build configuration
Add space to avoid sphinx build error
2016-03-23 19:20:54 -07:00
Carol Willing
fbb0829bbc Remove rst versions of nb 2016-03-22 18:28:43 -07:00
Matthias Bussonnier
c94023758e Fix some spelling 2016-03-22 09:40:09 -07:00
Matthias Bussonnier
98484fe35a add docs 2016-03-21 17:20:32 -07:00
Matthias Geier
6da2ea0cd1 Restore "development FAQ", but keep only the first item 2016-03-19 17:43:40 +01:00
Jonathan Frederic
6c286930da Merge pull request #15 from willingc/update-nb
Fix typo found by @minrk
2016-03-16 08:48:13 -04:00
Carol Willing
75386815d8 Update the table of contents 2016-03-15 22:30:48 -07:00
Carol Willing
915920ac72 Fix typo found by @minrk 2016-03-15 05:02:44 -07:00
Carol Willing
33a58c8bcb Fix @nbollweg comments 2016-03-14 13:28:34 -07:00
Carol Willing
8b202574ef Edit documentation notebook 2016-03-14 13:28:19 -07:00
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