upstream/ipython Files · docs/Makefile

Fix exception color problems in win32....

Fix exception color problems in win32. In all the recent work to have the test suite play nice with doctest of full ipython sessions, I inadvertedly started sending exceptions directly to sys.stderr. On windows we MUST go via Term.cerr, which uses pyreadline to handle color escapes, while sys.stderr just shows garbage on screen. As of this revision, the test suite passes fully on win32 and linux, and interactive use also seems OK on all fronts. We're getting closer to RC status...

Fernando Perez - - Load All Authors

File last commit:

r2339:eb010065


                r2459:e687d797

Download file

             Makefile
        
                    93 lines
            
             | 2.7 KiB
            
                | text/x-makefile
            
             |
                MakefileLexer
            
             / docs / Makefile
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      # Makefile for Sphinx documentation

      #

      # You can set these variables from the command line.

      SPHINXOPTS    =

      SPHINXBUILD   = sphinx-build

      PAPER         =

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      SRCDIR        = source

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      # Internal variables.

      PAPEROPT_a4     = -D latex_paper_size=a4

      PAPEROPT_letter = -D latex_paper_size=letter

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Fernando Perez
    
Several small fixes during code review with Brian....

              r2339
            
      default: html

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      help:

      	@echo "Please use \`make <target>' where <target> is one of"

      	@echo "  html      to make standalone HTML files"

      	@echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"

      	@echo "  htmlhelp  to make HTML files and a HTML help project"

      	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

      	@echo "  changes   to make an overview over all changed/added/deprecated items"

      	@echo "  linkcheck to check all external links for integrity"

        Fernando Perez
    
Fixes to build/setup machinery....

              r1525
            
      	@echo

      	@echo "Compound utility targets:"

      	@echo "pdf          latex and then runs the PDF generation"

      	@echo "all          html and pdf"

      	@echo "dist         all, and then puts the results in dist/"

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      clean:

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      	-rm -rf build/* dist/* $(SRCDIR)/api/generated

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Fernando Perez
    
Fixes to build/setup machinery....

              r1525
            
      pdf: latex

      	cd build/latex && make all-pdf

      all: html pdf

        Fernando Perez
    
Final updates for releasing the 0.9.rc1....

              r1596
            
      dist: clean all

        Fernando Perez
    
Fixes to build/setup machinery....

              r1525
            
      	mkdir -p dist

        Fernando Perez
    
Final updates for releasing the 0.9.rc1....

              r1596
            
      	ln build/latex/ipython.pdf dist/

        Fernando Perez
    
Fixes to build/setup machinery....

              r1525
            
      	cp -al build/html dist/

      	@echo "Build finished.  Final docs are in dist/"

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      html: api

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      	mkdir -p build/html build/doctrees

      	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html

      	@echo

      	@echo "Build finished. The HTML pages are in build/html."

        Fernando Perez
    
Update docs for automatic API building.

              r1850
            
      api:

      	python autogen_api.py

      	@echo "Build API docs finished."

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      pickle:

      	mkdir -p build/pickle build/doctrees

      	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle

      	@echo

      	@echo "Build finished; now you can process the pickle files or run"

      	@echo "  sphinx-web build/pickle"

      	@echo "to start the sphinx-web server."

      web: pickle

      htmlhelp:

      	mkdir -p build/htmlhelp build/doctrees

      	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp

      	@echo

      	@echo "Build finished; now you can run HTML Help Workshop with the" \

      	      ".hhp project file in build/htmlhelp."

      latex:

      	mkdir -p build/latex build/doctrees

      	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex

      	@echo

      	@echo "Build finished; the LaTeX files are in build/latex."

      	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \

      	      "run these through (pdf)latex."

      changes:

      	mkdir -p build/changes build/doctrees

      	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes

      	@echo

      	@echo "The overview file is in build/changes."

      linkcheck:

      	mkdir -p build/linkcheck build/doctrees

      	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck

      	@echo

      	@echo "Link check complete; look for any errors in the above output " \

      	      "or in build/linkcheck/output.txt."

	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

Brian E Granger Beginning to organize the rst documentation.	r1256	# Makefile for Sphinx documentation
		#

		# You can set these variables from the command line.
		SPHINXOPTS =
		SPHINXBUILD = sphinx-build
		PAPER =
Fernando Perez Update docs for automatic API building.	r1850	SRCDIR = source
Brian E Granger Beginning to organize the rst documentation.	r1256
		# Internal variables.
		PAPEROPT_a4 = -D latex_paper_size=a4
		PAPEROPT_letter = -D latex_paper_size=letter
Fernando Perez Update docs for automatic API building.	r1850	ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
Brian E Granger Beginning to organize the rst documentation.	r1256
Fernando Perez Update docs for automatic API building.	r1850	.PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
Brian E Granger Beginning to organize the rst documentation.	r1256
Fernando Perez Several small fixes during code review with Brian....	r2339	default: html

Brian E Granger Beginning to organize the rst documentation.	r1256	help:
		@echo "Please use \`make <target>' where <target> is one of"
		@echo " html to make standalone HTML files"
		@echo " pickle to make pickle files (usable by e.g. sphinx-web)"
		@echo " htmlhelp to make HTML files and a HTML help project"
		@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
		@echo " changes to make an overview over all changed/added/deprecated items"
		@echo " linkcheck to check all external links for integrity"
Fernando Perez Fixes to build/setup machinery....	r1525	@echo
		@echo "Compound utility targets:"
		@echo "pdf latex and then runs the PDF generation"
		@echo "all html and pdf"
		@echo "dist all, and then puts the results in dist/"
Brian E Granger Beginning to organize the rst documentation.	r1256
		clean:
Fernando Perez Update docs for automatic API building.	r1850	-rm -rf build/* dist/* $(SRCDIR)/api/generated
Brian E Granger Beginning to organize the rst documentation.	r1256
Fernando Perez Fixes to build/setup machinery....	r1525	pdf: latex
		cd build/latex && make all-pdf

		all: html pdf

Fernando Perez Final updates for releasing the 0.9.rc1....	r1596	dist: clean all
Fernando Perez Fixes to build/setup machinery....	r1525	mkdir -p dist
Fernando Perez Final updates for releasing the 0.9.rc1....	r1596	ln build/latex/ipython.pdf dist/
Fernando Perez Fixes to build/setup machinery....	r1525	cp -al build/html dist/
		@echo "Build finished. Final docs are in dist/"

Fernando Perez Update docs for automatic API building.	r1850	html: api
Brian E Granger Beginning to organize the rst documentation.	r1256	mkdir -p build/html build/doctrees
		$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
		@echo
		@echo "Build finished. The HTML pages are in build/html."

Fernando Perez Update docs for automatic API building.	r1850	api:
		python autogen_api.py
		@echo "Build API docs finished."

Brian E Granger Beginning to organize the rst documentation.	r1256	pickle:
		mkdir -p build/pickle build/doctrees
		$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
		@echo
		@echo "Build finished; now you can process the pickle files or run"
		@echo " sphinx-web build/pickle"
		@echo "to start the sphinx-web server."

		web: pickle

		htmlhelp:
		mkdir -p build/htmlhelp build/doctrees
		$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
		@echo
		@echo "Build finished; now you can run HTML Help Workshop with the" \
		".hhp project file in build/htmlhelp."

		latex:
		mkdir -p build/latex build/doctrees
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
		@echo
		@echo "Build finished; the LaTeX files are in build/latex."
		@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
		"run these through (pdf)latex."

		changes:
		mkdir -p build/changes build/doctrees
		$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
		@echo
		@echo "The overview file is in build/changes."

		linkcheck:
		mkdir -p build/linkcheck build/doctrees
		$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
		@echo
		@echo "Link check complete; look for any errors in the above output " \
		"or in build/linkcheck/output.txt."