Commit Graph

508 Commits

Author SHA1 Message Date
Miro Hrončok
6e1ac76423 Have _ defined in notebook.transutils
Import it in conf.py (docs)

Fixes https://github.com/jupyter/notebook/issues/2798
2017-08-24 11:58:38 +02:00
madhu
11b22d280c docs(notebook): Update changelog for 5.1 2017-08-20 21:17:04 +05:30
Benda Xu
db90e16d17 d/s/examples/N/Importing Notebooks.ipynb: disable execution.
This notebook example includes writing to the directory of another
  module, usually resulting in a doc build failure.  Therefore we
  disable its execution by nbsphinx.

Closes: #2372
See-Also: https://bugs.gentoo.org/show_bug.cgi?id=626860
2017-08-19 17:31:38 +09:00
Grant Nestor
1f1728260a More corrections 2017-08-03 17:21:00 -04:00
Grant Nestor
cea19ffa7c Corrections 2017-08-03 17:02:27 -04:00
Grant Nestor
975d42ae94 Add 5.1.0 to changelog 2017-08-03 15:58:11 -04:00
Grant Nestor
f42ef1a5f5 Remove quotes around URL in tornado_settings example 2017-07-26 14:27:23 -07:00
Thomas Kluyver
ec43b45dd5 Merge pull request #2612 from minrk/double-pre
remove redundant pre tags in markdown examples
2017-07-03 11:51:16 +01:00
M Pacer
9e9432a7b9 Remove references to heading cells and 'best practices' that better fit the existence of heading cells 2017-06-28 13:41:41 -07:00
Min RK
24835421b4 remove redundant pre tags
Some markdown examples were double-escaped (indent and pre tag),
causing incorrect rendering.
2017-06-28 13:58:58 +01:00
Harsh Vardhan
462ed6c01e Update link of messaging in Jupyter
The documentation is for an old version of IPython.
2017-06-27 16:35:52 +05:30
Dominic Kuang
63cc96ed1c Change comment identifier to be valid JavaScript
Copying and pasting the snippet with `#` as a comment identifier caused an error, so use `//` instead.
2017-06-12 10:35:26 -07:00
Steve (Gadget) Barnes
19d23e2de7 Issue #2502: Add line break after The Jupyter Notebook is running at: (#2505)
* Issue #2502: Add line break after The Jupyter Notebook is running at:

* Revert "Issue #2502: Add line break after The Jupyter Notebook is running at:"

This reverts commit 3aa65e7120.

* Issue #2502: Reverted previous changes and redone without strip trailing spaces
2017-05-19 17:25:22 +01:00
Björn Grüning
89fe391543 wording fix 2017-04-26 21:08:30 +02:00
Grant Nestor
ce110e6d5d Fix typo in cell tags toolbar screenshot 2017-04-03 11:14:26 -07:00
Grant Nestor
0d289458e8 Update changelog and screenshots 2017-03-30 16:43:45 -05:00
Thomas Kluyver
d2c539fdbc Explain how to use cell tags in changelog 2017-03-21 17:04:08 +00:00
Thomas Kluyver
9f8158abb6 Use Markdown image references in example notebook
This makes the high-res screenshots larger on a lower-res screen, but
nbsphinx doesn't currently handle HTML <img> tags, so we need to use the
Markdown format to show images in our docs.

Closes gh-2304
2017-03-20 15:24:07 +00:00
Peter Parente
7816203665 Note bundler API, kernel activity additions 2017-02-26 21:51:51 -05:00
Matthias Bussonnier
0736356a2f Merge pull request #2224 from takluyver/doc-nbserver-extensions
Update docs on enabling notebook server extensions
2017-02-25 20:08:29 -08:00
nickylimjj
0d595f323c keep within 80 cols, fix typos 2017-02-25 10:46:12 -06:00
nickylimjj
0be70718a5 updated changelog for nbextensions 2017-02-25 01:09:00 -06:00
Thomas Kluyver
a38eadbfef Fix spelling 2017-02-24 18:26:13 +00:00
Thomas Kluyver
e3b89c3910 Update docs on enabling notebook server extensions 2017-02-24 18:25:33 +00:00
Eric Dill
080fae28e5 DOC: Fix typo 2017-02-12 19:45:52 -05:00
Grant Nestor
8420668e95 Uncomment 5.0 section in changelog 2017-02-08 18:39:21 -08:00
Grant Nestor
f924613ede Add 4.4 to changelog 2017-02-08 16:17:58 -08:00
Thomas Kluyver
d51fa4bec7 Centre images 2017-02-07 15:43:56 +00:00
Thomas Kluyver
477332696b Work on changelog for 5.0
We seem to have missed the extension that defines Github issue & PR
links until now.
2017-02-07 15:37:09 +00:00
Thomas Kluyver
8fbf1fb1ce Merge pull request #2104 from Carreau/shortcut-edit-menu
Add a menu item to edit keyboard shortcuts.
2017-02-02 09:58:23 +00:00
Matthias Bussonnier
90429adba4 Add a menu item to edit keyboard shortcuts. 2017-02-01 14:55:10 -08:00
Thomas Kluyver
c807268e4c Clarify where docs are specific to IPython
Closes gh-1504
2017-02-01 12:05:43 -06:00
Carol Willing
ad805b1c51 Merge pull request #2105 from Carreau/edit-changelog
Start to list new features in changelog
2017-01-31 21:16:12 -08:00
Matthias Bussonnier
7850fae923 Merge pull request #2099 from takluyver/docs-eg-nbs-links
Update some links to example notebooks in docs
2017-01-31 20:44:02 -08:00
Matthias Bussonnier
9988ce1e6f Start to list new features in changelog 2017-01-31 20:41:39 -08:00
Thomas Kluyver
5bb475e1c2 Update nbviewer Github URLs 2017-01-31 16:01:32 +00:00
Thomas Kluyver
1b47ac7248 Restore https 2017-01-31 15:36:43 +00:00
Thomas Kluyver
7aa778166e Update Intersphinx URL for IPython 2017-01-31 15:36:00 +00:00
Thomas Kluyver
9058de7ab7 Remove link to outdated note about roundtrip conversions 2017-01-31 15:34:50 +00:00
Thomas Kluyver
99ad2091fb Update links to example notebooks
Closes gh-953 (fixing link to markdown cells example nb)
2017-01-31 15:33:37 +00:00
Grant Nestor
52ba4c9a4f Update changelog 2017-01-30 16:45:51 -08:00
kikocorreoso
72769862f9 doc typos related with issue #2069 2017-01-27 08:59:13 +01:00
clarka34
7ab7fd0c24 Update button icon.
Changed button icon so it displays properly. Previously, it displayed an empty icon.
2017-01-15 23:38:26 -08:00
Kyle Kelley
f5f97d1f93 Merge pull request #2007 from minrk/password
add `jupyter notebook password` entrypoint
2017-01-13 09:55:27 -06:00
Dennis
b97336c35d typo an to and 2017-01-07 19:20:36 +02:00
Min RK
f7b85b0999 include jupyter notebook password entrypoint in secure notebook docs 2017-01-03 15:27:02 +01:00
Min RK
0b50201ae4 note downgrade of CodeMirror in changelog 2016-12-21 22:31:00 +01:00
Min RK
86c6268f64 prose review 2016-12-21 22:31:00 +01:00
Min RK
dacea0e0d9 changelog notes for 4.3.1 2016-12-21 22:31:00 +01:00
Grant Nestor
2113b461de Add 4.3.1 to changelog 2016-12-21 11:43:43 -08:00
Min RK
7fa5d5a1be cover token authentication in security docs 2016-12-13 13:09:55 +01:00
Thomas Kluyver
32f92b489e Merge pull request #1955 from gnestor/4.3
Add 4.3 to changelog
2016-12-08 15:32:46 +01:00
Grant Nestor
74b935e6b5 Add 4.3 to changelog 2016-12-07 12:05:12 -08:00
plysaght
b431a9a11a Fixed typo in 1st line of Browser Compatibility section 2016-12-05 12:18:34 -08:00
michaelpacer
50c7df0958 adding link to actual source file per spatialaudio/nbsphinx#74 2016-11-29 09:51:17 -08:00
michaelpacer
791e398679 Fix sphinx warning about new lines after markup 2016-11-28 16:55:15 -08:00
michaelpacer
9e3e946a42 Change sourcecode:: to code-block:: 2016-11-28 15:43:10 -08:00
michaelpacer
d751f177c3 Remove redundant code-block invocation 2016-11-28 15:13:11 -08:00
Thomas Kluyver
8f7825031f Fix highlighting of Python code blocks
The configuration on RTD doesn't default to Python highlighting, it
seems.

http://jupyter-notebook.readthedocs.io/en/latest/comms.html
2016-11-20 13:56:58 +00:00
Carol Willing
6b76f0aa8c Edit from @takluyver review 2016-11-03 18:32:29 -07:00
Carol Willing
f138c32719 Minor edits to comms doc 2016-11-03 18:09:52 -07:00
Thomas Kluyver
5cdc8682d3 Start documenting how to use Comms
See gh-1869
2016-11-03 16:00:46 -07:00
Thomas Kluyver
b5acf7bf1c More updates to security doc 2016-10-24 10:59:11 +01:00
Grant Nestor
40660e6102 Update security docs to reflect new signature system 2016-10-23 16:38:33 -07:00
Adam Chainz
a947025308 Convert readthedocs links for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-10-09 21:56:18 +01:00
Carol Willing
f2f916315c Edits to correct rst errors found by doc8 2016-10-02 14:44:02 -07:00
Matthias Bussonnier
c70455b779 Merge pull request #1792 from spoorthyv/master
Updated Jupyter Logos to Fit New Guidelines
2016-09-28 13:07:05 -07:00
spoorthyv
6a3260b435 Updated Jupyter Logos 2016-09-27 16:11:41 -07:00
Christoph Klein
dfa257cbcc Fix minor typos in notebook server docs 2016-09-27 15:30:39 -04:00
Min RK
28c5d98196 Release notes for 4.2.3 2016-09-16 11:26:58 +02:00
Pierre Carru
a327ce804b docs: Update dead links 2016-09-09 16:30:07 +02:00
Carol Willing
62f3f3de00 Remove second Python version 2016-09-06 11:19:54 -07:00
Carol Willing
e2c2037f1f Remove anaconda cloud from metadata 2016-09-06 11:15:19 -07:00
michaelpacer
ec632df150 Make jupyter dir location more specific 2016-09-05 14:37:02 -07:00
dm-wyncode
c476e78b5b Attempted to correct a URL that was a dead link. I inserted my best
guess to the updated version.
	modified:   docs/source/examples/Notebook/JavaScript Notebook Extensions.ipynb
2016-09-03 16:43:50 +00:00
Thomas Kluyver
3026b25cfb Update release docs for PEP 527 2016-09-01 15:21:41 +01:00
michaelpacer
e8b4ebc4a6 Add note on JupyterHub to docs 2016-08-25 19:39:07 -07:00
Min RK
f396334380 Merge pull request #1579 from parente/bundler-api
Bundler extension API
2016-08-13 22:03:15 +02:00
Min RK
3dce57501a Changelog for 4.2.2 2016-08-05 10:40:42 +02:00
Peter Parente
2473efcb3d Update Distributing Jupyter Extensions doc
* Add tarball_bundler example inline
* Add tarball_bundler example to bundler doc too
* Cross-ref from distributing doc to doc about writing extensions

(c) Copyright IBM Corp. 2016
2016-07-05 14:53:00 -04:00
Peter Parente
4a3386663c New bundler extensions developer doc
* Improve some docstrings too
* Fix a busted extension link along the way

(c) Copyright IBM Corp. 2016
2016-07-05 13:12:03 -04:00
Min RK
a12e6e4d05 changes for 4.2.1 2016-06-03 13:51:20 +02:00
Min RK
12d5189e95 remove discussion of IPython profiles from notebook signatures docs 2016-06-01 11:01:48 +02:00
Carol Willing
eac86ab13b Edits to text 2016-05-06 14:14:55 -07:00
Matthias Bussonnier
1838e966e6 Document kernel.js extensions. 2016-05-06 12:06:04 -07:00
Yuval Langer
80ae2c9322 Use fixed version number. 2016-05-03 20:07:28 +03:00
Yuval Langer
cbbc713a77 Make Importing Notebooks guide work again. 2016-05-03 19:07:33 +03:00
Carol Willing
215244b5f6 Fix minor formatting error 2016-05-02 15:27:33 -07:00
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