upstream/ipython Files · tools/mknbindex.py

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

Fernando Perez - - Load All Authors

File last commit:

r9711:e20ba071


                r24067:fcbe9bad

Download file

             mknbindex.py
        
                    36 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / tools / mknbindex.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python

      """Simple script to auto-generate the index of notebooks in a given directory.

      """

      import glob

      import urllib

      notebooks = sorted(glob.glob('*.ipynb'))

      tpl = ( '* [{0}](http://nbviewer.ipython.org/url/github.com/ipython/ipython/'

              'raw/master/examples/notebooks/{1})' )

      idx = [ 

      """# A collection of Notebooks for using IPython effectively

      The following notebooks showcase multiple aspects of IPython, from its basic

      use to more advanced scenarios.  They introduce you to the use of the Notebook

      and also cover aspects of IPython that are available in other clients, such as

      the cell magics for multi-language integration or our extended display

      protocol.

      For beginners, we recommend that you start with the 5-part series that

      introduces the system, and later read others as the topics interest you.

      Once you are familiar with the notebook system, we encourage you to visit our

      [gallery](https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks)

      where you will find many more examples that cover areas from basic Python

      programming to advanced topics in scientific computing.

      """]

      idx.extend(tpl.format(nb.replace('.ipynb',''), urllib.quote(nb)) 

                 for nb in notebooks)

      with open('README.md', 'w') as f:

          f.write('\n'.join(idx))

          f.write('\n')

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				#!/usr/bin/env python
				"""Simple script to auto-generate the index of notebooks in a given directory.
				"""

				import glob
				import urllib

				notebooks = sorted(glob.glob('*.ipynb'))

				tpl = ( '* [{0}](http://nbviewer.ipython.org/url/github.com/ipython/ipython/'
				'raw/master/examples/notebooks/{1})' )

				idx = [
				"""# A collection of Notebooks for using IPython effectively

				The following notebooks showcase multiple aspects of IPython, from its basic
				use to more advanced scenarios. They introduce you to the use of the Notebook
				and also cover aspects of IPython that are available in other clients, such as
				the cell magics for multi-language integration or our extended display
				protocol.

				For beginners, we recommend that you start with the 5-part series that
				introduces the system, and later read others as the topics interest you.

				Once you are familiar with the notebook system, we encourage you to visit our
				[gallery](https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks)
				where you will find many more examples that cover areas from basic Python
				programming to advanced topics in scientific computing.
				"""]

				idx.extend(tpl.format(nb.replace('.ipynb',''), urllib.quote(nb))
				for nb in notebooks)

				with open('README.md', 'w') as f:
				f.write('\n'.join(idx))
				f.write('\n')