Docs updates - sort list

docs/source/autogen_scripts/autogen_nbextensions_list.py

@@ -56,6 +56,15 @@
 List of provided nbextensions
 =============================
 
+.. the hidden toc is used to suppress warnings about readmes which are
+.. not for individual nbextensions, but are linked to by nbextensions'
+.. individual readmes
+
+.. toctree::
+    :hidden:
+
+    nbextensions/code_prettify/README
+
 .. toctree::
    :maxdepth: 1
 
@@ -64,7 +73,9 @@
 with open(destination, 'w') as f:
     f.write(header)
     f.writelines([
-        '   {}\n'.format(
-            'nbextensions/' + os.path.splitext(nbext['readme'])[0])
+        '   {} <nbextensions/{}>\n'.format(
+            nbext['Name'],
+            os.path.splitext(nbext['readme'])[0]
+        )
         for nbext in nbextensions if nbext.get('readme')
     ])

docs/source/conf.py

@@ -54,8 +54,11 @@
 # directories to ignore when looking for source files.
 exclude_patterns = [
     '**/.ipynb_checkpoints',
+    # the history file isn't linked to by either of the main exercise readmes
     'nbextensions/exercise/history.md',
+    # slidemode2 has no yaml, so this won't be linked to in autogenerated toc
     'nbextensions/slidemode/slidemode2/README.md',
+    # latex_envs includes its readme twice, but we only use one copy
     'nbextensions/latex_envs/doc/README.md',
 ]
 
@@ -82,6 +85,11 @@
 
 suppress_warnings = ['image.nonlocal_uri']
 
+# regex patterns for the beginning of links not to check
+linkcheck_ignore = [
+    r'https?://(localhost|127\.0\.0\.1):\d+/',  # local links
+]
+
 # -- Options for HTML output --------------------------------------------------
 
 if not on_rtd:  # only import and set the theme if we're building docs locally

docs/source/index.rst

@@ -2,15 +2,19 @@
 Unofficial Jupyter Notebook Extensions
 ======================================
 
-The ``jupyter_notebook_extensions`` package contains a  collection of extensions that add
-functionality to the Jupyter notebook. These extensions are mostly written in Javascript and
-will be loaded locally in your browser.
+The ``jupyter_contrib_nbextensions`` package contains a collection of
+community-contributed unofficial extensions that add functionality to the
+Jupyter notebook.
+These extensions are mostly written in Javascript and will be loaded locally
+in your browser.
 
-The IPython-contrib repository is maintained independently by a group of
+The
+`IPython-contrib repository <https://github.com/ipython-contrib/jupyter_contrib_nbextensions>`__
+is maintained independently by a group of
 users and developers and not officially related to the IPython
 development team.
 
-The maturity of the provided extensions varies, so please `create an
+The maturity of the provided nbextensions varies, so please `create an
 issue <https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/new>`__
 at the project's `github
 repository <https://github.com/ipython-contrib/jupyter_contrib_nbextensions>`__
@@ -27,5 +31,5 @@ Contents:
    nbextensions
    troubleshooting
    exporting
-   config
    internals
+   config

docs/source/internals.rst

@@ -92,9 +92,7 @@ And for the `config.yaml` file:
 When supplying a `readme.md` file, please supply a main heading with the
 nbextension's title, as this will be linked in the generated documentation at
 `jupyter-contrib-nbextensions.readthedocs.io <http://jupyter-contrib-nbextensions.readthedocs.io/en/latest>`__.
-This is a simple example for `readme.md`:
-
-.. code-block:: markdown
+This is a simple example for `readme.md`::
 
     This extension
     ==============

src/jupyter_contrib_nbextensions/nbextensions/code_prettify/README_code_prettify.md

@@ -280,7 +280,7 @@ History
 [@jcb91]: https://github.com/jcb91
 [@jfbercher]: https://github.com/jfbercher
 [autopep8]: https://github.com/hhatto/autopep8
-[formatR]: http://yihui.name/formatR
+[formatR]: https://yihui.name/formatr
 [http://fontawesome.io/icons]: http://fontawesome.io/icons
 [ijavascript]: http://n-riesco.github.io/ijavascript
 [internals]: #Internals

src/jupyter_contrib_nbextensions/nbextensions/hinterland/README.md

@@ -9,7 +9,7 @@ and offers some options for configuration:
 
 
 Options
-=======
+-------
 
 * `hinterland.hint_delay`:
   delay in milliseconds between keypress & hint request. This is used to help

src/jupyter_contrib_nbextensions/nbextensions/keyboard_shortcut_editor/README.md

@@ -80,10 +80,9 @@ The extension stores a record of the edits in use in the config, as a list
 of objects for each mode. Those without a `to` key denote shortcuts to disable,
 while those without a `from` key denote new shortcuts. For example:
 
-```json
+```javascript
 // the config object with section name 'notebook' at the base URL
 {
-  ...
   "kse_rebinds": {
     // command-mode rebindings
     'command': [
@@ -109,7 +108,7 @@ while those without a `from` key denote new shortcuts. For example:
       }
     ]
   },
-  ...
+  // other config keys may be present in this file!
 }
 ```
 

src/jupyter_contrib_nbextensions/nbextensions/snippets/snippets.yaml

@@ -3,4 +3,4 @@ Compatibility: 4.x
 Name: Snippets
 Main: main.js
 Description: Adds a drop-down menu to insert snippet cells into the current notebook.
-Link: readme.md
+Link: README.md