upstream/ipython Files · IPython/testing/plugin/Makefile

add a little detail to custom repr method docs (#13945)...

add a little detail to custom repr method docs (#13945) These docs are a bit sparse, so I added a couple details that might help implementers: - explicitly state the return type, rather than only via example - give some examples of PNG, HTML - note that formatters shouldn't be sensitive to other formats related to https://github.com/Textualize/rich/pull/2806 which didn't follow the spec, in part I think because the docs weren't explicit enough about exactly what a formatter should do.

Matthias Bussonnier - - Load All Authors

File last commit:

r25147:babedc8a


                r28126:29190f63

Download file

             Makefile
        
                    74 lines
            
             | 1.4 KiB
            
                | text/x-makefile
            
             |
                MakefileLexer
            
             / IPython / testing / plugin / Makefile
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # Set this prefix to where you want to install the plugin

      PREFIX=/usr/local

      NOSE0=nosetests -vs --with-doctest --doctest-tests --detailed-errors

      NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt \

      --detailed-errors

      SRC=ipdoctest.py setup.py ../decorators.py

      # Default target for clean 'make'

      default: interactiveshell

      # The actual plugin installation

      plugin: IPython_doctest_plugin.egg-info

      # Simple targets that test one thing

      simple: plugin simple.py

      	$(NOSE) simple.py

      dtest: plugin dtexample.py

      	$(NOSE) dtexample.py

      rtest: plugin test_refs.py

      	$(NOSE) test_refs.py

      test: plugin dtexample.py

      	$(NOSE) dtexample.py test*.py test*.txt

      deb: plugin dtexample.py

      	$(NOSE) test_combo.txt

      # IPython tests

      deco:

      	$(NOSE0) IPython.testing.decorators

      magic: plugin

      	$(NOSE) IPython.core.magic

      excolors: plugin

      	$(NOSE) IPython.core.excolors

      interactiveshell: plugin

      	$(NOSE)  IPython.core.interactiveshell

      strd: plugin

      	$(NOSE) IPython.core.strdispatch

      engine: plugin

      	$(NOSE) IPython.kernel

      tf: plugin

      	$(NOSE) IPython.config.traitlets

      # All of ipython itself

      ipython: plugin

      	$(NOSE) IPython

      # Combined targets

      sr: rtest strd

      base: dtest rtest test strd deco

      quick: base interactiveshell ipipe

      all: base ipython

      # Main plugin and cleanup

      IPython_doctest_plugin.egg-info: $(SRC)

      	pip install . --prefix=$(PREFIX)

      	touch $@

      clean:

      	rm -rf IPython_doctest_plugin.egg-info *~ *pyc build/ dist/

	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

				# Set this prefix to where you want to install the plugin
				PREFIX=/usr/local

				NOSE0=nosetests -vs --with-doctest --doctest-tests --detailed-errors
				NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt \
				--detailed-errors

				SRC=ipdoctest.py setup.py ../decorators.py

				# Default target for clean 'make'
				default: interactiveshell

				# The actual plugin installation
				plugin: IPython_doctest_plugin.egg-info

				# Simple targets that test one thing
				simple: plugin simple.py
				$(NOSE) simple.py

				dtest: plugin dtexample.py
				$(NOSE) dtexample.py

				rtest: plugin test_refs.py
				$(NOSE) test_refs.py

				test: plugin dtexample.py
				$(NOSE) dtexample.py test.py test.txt

				deb: plugin dtexample.py
				$(NOSE) test_combo.txt

				# IPython tests
				deco:
				$(NOSE0) IPython.testing.decorators

				magic: plugin
				$(NOSE) IPython.core.magic

				excolors: plugin
				$(NOSE) IPython.core.excolors

				interactiveshell: plugin
				$(NOSE) IPython.core.interactiveshell

				strd: plugin
				$(NOSE) IPython.core.strdispatch

				engine: plugin
				$(NOSE) IPython.kernel

				tf: plugin
				$(NOSE) IPython.config.traitlets

				# All of ipython itself
				ipython: plugin
				$(NOSE) IPython


				# Combined targets
				sr: rtest strd

				base: dtest rtest test strd deco

				quick: base interactiveshell ipipe

				all: base ipython

				# Main plugin and cleanup
				IPython_doctest_plugin.egg-info: $(SRC)
				pip install . --prefix=$(PREFIX)
				touch $@

				clean:
				rm -rf IPython_doctest_plugin.egg-info ~ pyc build/ dist/