Commit Graph

55 Commits

Author SHA1 Message Date
Vidar Tonaas Fauske
7bf9b5ec68
Document contents chunks (#5508)
* Document contents chunks

Add a documentation entry for the contents API regarding use of "chunk" in save.

Adds an `extra_requires` value in setup.py for installing documentation dependencies.
2020-06-05 08:24:00 -07:00
Vidar Tonaas Fauske
2249fba51b
Update contents.rst 2019-10-31 10:26:06 +00:00
Vidar Tonaas Fauske
5280bf60a5
Clarify contents api further 2019-10-31 10:18:52 +00:00
Vidar Tonaas Fauske
24e4a2e4f5
Update docs/source/extending/contents.rst
Co-Authored-By: Zachary Sailer <zachsailer@gmail.com>
2019-09-30 23:49:05 +01:00
Vidar Tonaas Fauske
4c0d055546
Remove extra whitespace 2019-09-02 16:40:16 +01:00
Vidar Tonaas Fauske
5563392f4b
Update contents API docs
Not the contents API docs better match the default notebook implementation:

c2d4561ba6/notebook/services/contents/filemanager.py (L362)
2019-09-02 16:38:33 +01: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
Min RK
7657c0ca5f [doc] fix some linkcheck errors and warnings 2019-03-27 13:43:15 +01:00
Michael Chirico
ffb486453f
remove vestigial lines from documentation
Found here:
2018-09-12 17:37:14 +08:00
Aaron Hall, MBA
b644d7ee40
indent code block 2018-07-30 12:49:34 -04:00
Min RK
1d17c796d0
Merge pull request #3799 from aaronchall/patch-1
Fill in Checkpoints section
2018-07-30 10:04:27 +02:00
Aaron Hall, MBA
251c9e7dc8
Fill in Checkpoints section
(I think it needs more complete examples like ContentsManager has regarding what is returned by these methods.)
2018-07-26 13:51:58 -04:00
Walter Martin
ecc4d26f1d fixing grammatical errors and typos 2018-07-24 21:01:51 -04:00
dabuside
9936aa9eab
warp line 2018-04-11 18:43:34 +08:00
dabuside
37c6ba2cc1
add tips 2018-04-11 18:30:58 +08:00
dabuside
82ff0fdceb
add tips 2018-04-11 10:06:27 +08:00
PHaeJin
c0973877c8 Fix a typo (#3043)
* Fix a typo

* Fix a typo

* Fix abroken link
2017-11-13 15:41:15 +00:00
edida
9f72eb1867 Typo fix (#3033) 2017-11-10 10:31:34 +00:00
Vidar Tonaas Fauske
f6de61d34e Fix some broken links and permanent redirects 2017-09-01 13:09:51 +02: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
kikocorreoso
72769862f9 doc typos related with issue #2069 2017-01-27 08:59:13 +01: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
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
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
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
Steven Silvester
1d32e7cdac Update link to swatter docs 2016-03-29 14:59:49 -07:00
Min RK
41d6da235c Merge pull request #879 from ellisonbg/nbext-pain
New nbextensions installation API
2016-03-25 22:02:22 -07: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
212d517a92 Merge pull request #1234 from Carreau:keyb
Make keyboard shortcuts declarative
2016-03-24 12:59:12 +01:00
Carol Willing
a13bff8850 Add frontend doc 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
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
anirudhjoshi
eb2764bbad Fixed missing import of to_api_path in example 2016-01-04 11:06:18 +11: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
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