Commit Graph

114 Commits

Author SHA1 Message Date
Jeremy Tuloup
b1706303e7 Iterate on the README 2022-03-02 10:05:57 +01:00
Kevin Bates
6675ca9728
Pin nbsphinx to 0.8.6, clean up orphaned resources 2021-10-05 16:50:59 -07:00
Afshin Taylor Darian
c19323de9a
Use Jupyter Releaser (#6048)
* Use Jupyter Releaser

* Automated Changelog Entry for 6.4.0a0 on notebook-releaser

* Publish 6.4.0a0

SHA256 hashes:

dist/notebook-6.4.0a0-py3-none-any.whl: abbbbb02504cedb85c2d5eeac39ea11615360b9b0075126bf180d6011eac14a5

dist/notebook-6.4.0a0.tar.gz: 2984630a020a9396c61b2c3b98f43b1957dd0121b162a926b3d6136fafa7ca16

* Bump to 6.5.0.dev0

* Remove jupyter_packaging as a runtime requirement

* Automated Changelog Entry for 6.4.0a1 on notebook-releaser

* Publish 6.4.0a1

SHA256 hashes:

dist/notebook-6.4.0a1-py3-none-any.whl: 4b0ae5cb972b5b16b18b942810b85859185ef2081017dd495e5f57099ce06ef4

dist/notebook-6.4.0a1.tar.gz: c48e10d34afa35e304e3b7deca1882508195960f35c4661dec044bb8da344ae5

* Bump to 6.5.0.dev0

* Update notebook/_version.py

Co-authored-by: Kevin Bates <kbates4@gmail.com>

* Update pyproject.toml

Co-authored-by: Kevin Bates <kbates4@gmail.com>

Co-authored-by: GitHub Action <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Steven Silvester <steven.silvester@ieee.org>
Co-authored-by: Kevin Bates <kbates4@gmail.com>
2021-05-12 11:04:31 -05:00
wggillen
8ca2887920
Spelling correction (#6045)
An instance of 'attachment' was misspelled 'attachement'.
2021-04-25 10:29:06 -05:00
Matthias Geier
99adc0e5c4 example notebook: don't recommend using $$...$$ for display math 2020-12-01 17:34:21 +01:00
adcdr
05a9b02bb7
Fix broken links
The documentation linked below contains 3 rendering errors:
https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/What%20is%20the%20Jupyter%20Notebook.html

These are caused by limitations in the Sphinx tool used to render the page:
https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible

This PR fixes them with the least amount of changes.
2020-10-13 21:11:23 +01:00
Reece Hart
427bc961ee closes #4029: implement optional markdown header and footer files 2020-06-08 05:11:30 -05:00
Kyle Kelley
6308e979aa
Merge pull request #2922 from takluyver/run-cell-play
'Play' icon for run-cell toolbar button
2020-05-28 09:51:35 -07:00
Thew Dhanat
95c9dfbdb0
Add cell attachments to markdown example (#5412) 2020-05-21 03:31:39 -05:00
Thew Dhanat
1e7d764cfa
Update Markdown Cells example to HTML5 video tag 2020-04-29 19:01:32 +07:00
Wes Turner
491e7bda90 DOC: Fix MathJax links (fixes #4885) 2019-09-17 22:43:10 -04:00
David Robles
c2d4561ba6 Change 'if' to 'for' in C for loop example (#4850) 2019-08-30 20:08:00 -07:00
Min ho Kim
bd66c18b4f Fix typos (#4760)
* Fix typos

* Revert trimming whitespaces

* Revert trimming whitespaces

* Revert trimming whitespaces

* Revert trimming whitespaces

* Revert trimming whitespaces
2019-07-12 18:54:08 +01:00
Julian Rüth
973b06610b
Fix typo 2019-06-25 01:08:16 +02:00
Daniel Nicolai
0ca8639f60
Update Working With Markdown Cells.ipynb
Add explicit instruction for online documentation pages
2019-04-25 17:12:29 +02:00
Min RK
7657c0ca5f [doc] fix some linkcheck errors and warnings 2019-03-27 13:43:15 +01:00
Min RK
ff238cc762
Merge pull request #4147 from jakelevirne/master
Updated the description of Heading cells, which are no longer used
2019-03-06 10:28:50 +01:00
Min RK
73a7630517
there are four lights [ci skip] 2019-03-06 10:28:41 +01:00
Will Costello
5f8a2040ff
Fix typo in introduction 2019-01-05 20:16:05 +00:00
Chris Holdgraf
29f58de211 updating file tree 2018-12-16 18:43:38 -08:00
Tim Porath
48042adaf9 Add Documentation regarding backslash escaping in Markdown File 2018-12-09 18:42:30 -05:00
BuildTools
760d4d3533 fixed typo in example notebook 2018-10-26 14:17:48 -04:00
BuildTools
de7be3a64f Updated the description of Heading cells, which are no longer used 2018-10-26 14:02:49 -04:00
Thomas Kluyver
7a623d65e9
Merge pull request #3584 from takluyver/doc-troubleshooting
Documentation updates and organisation
2018-05-01 10:15:38 +02:00
Thomas Kluyver
c1b761890d
Merge pull request #3520 from bollwyvl/docs/confd-example
update docs with confd implementation details
2018-05-01 10:11:33 +02:00
Thomas Kluyver
cba22e8732 Reorganise docs landing page 2018-04-30 17:21:18 +02:00
Paul Masson
a860b9bd22
Typos 2018-04-11 12:52:13 -07:00
Nicholas Bollweg
fed254b184 update docs with confd implementation details 2018-04-10 01:09:07 -04:00
Hong Xu
08231369c1 Add explanation on how to change the type of a cell to Markdown. 2018-02-26 11:27:12 -08:00
Miro Hrončok
6453b0f1da Do not execute special notebooks with nbsphinx
They can hang in headless environment.

See also db90e16d17
2018-02-21 16:46:33 +01:00
Thomas Kluyver
b6edf5cf17 'Play' icon for run-cell toolbar button
Based on @ellisonbg's research in gh-2914, most tools with similar
functionality to run a piece of code use either the 'play' icon, or
something custom designed (RStudio and Spyder are in the latter camp).

The analogy with audio and video does suggest that 'step forward' is
more similar to running one cell, but it's not clear that users
are actually thinking about it in those terms.

I'm opening this for discussion rather than for immediate merge.
2017-10-11 11:21:46 +01:00
Vidar Tonaas Fauske
f6de61d34e Fix some broken links and permanent redirects 2017-09-01 13:09:51 +02:00
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
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
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
Eric Dill
080fae28e5 DOC: Fix typo 2017-02-12 19:45:52 -05: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
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
Dennis
b97336c35d typo an to and 2017-01-07 19:20:36 +02: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
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
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