upstream/ipython Commit - r2535:79187f6c

1

# Makefile for Sphinx documentation

1

# Makefile for Sphinx documentation

2

#

2

#

3

4

# You can set these variables from the command line.

4

# You can set these variables from the command line.

5

SPHINXOPTS =

5

SPHINXOPTS =

6

SPHINXBUILD = sphinx-build

6

SPHINXBUILD = sphinx-build

7

PAPER =

7

PAPER =

8

SRCDIR = source

8

SRCDIR = source

9

10

# Internal variables.

10

# Internal variables.

11

PAPEROPT_a4 = -D latex_paper_size=a4

11

PAPEROPT_a4 = -D latex_paper_size=a4

12

PAPEROPT_letter = -D latex_paper_size=letter

12

PAPEROPT_letter = -D latex_paper_size=letter

13

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

13

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

14

15

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

15

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

16

17

default: html

17

default: html

18

19

help:

19

help:

20

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

20

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

21

@echo " html to make standalone HTML files"

21

@echo " html to make standalone HTML files"

22

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

22

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

23

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

23

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

24

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

24

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

25

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

25

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

26

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

26

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

27

@echo

27

@echo

28

@echo "Compound utility targets:"

28

@echo "Compound utility targets:"

29

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

29

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

30

@echo "all html and pdf"

30

@echo "all html and pdf"

31

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

31

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

32

33

clean:

33

clean:

34

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

34

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

35

36

pdf: latex

36

pdf: latex

37

cd build/latex && make all-pdf

37

cd build/latex && make all-pdf

38

39

all: html pdf

39

all: html pdf

40

41

dist: clean all

41

dist: clean all

42

mkdir -p dist

42

mkdir -p dist

43

ln build/latex/ipython.pdf dist/

43

ln build/latex/ipython.pdf dist/

44

cp -al build/html dist/

44

cp -al build/html dist/

45

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

45

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

46

47

html: api

47

html: api

48

mkdir -p build/html build/doctrees

48

mkdir -p build/html build/doctrees

49

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

49

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

50

@echo

50

@echo

51

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

51

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

52

53

api:

53

api: source/api/generated/gen.txt

54

55

source/api/generated/gen.txt:

54

python autogen_api.py

56

python autogen_api.py

55

@echo "Build API docs finished."

57

@echo "Build API docs finished."

56

58

57

pickle:

59

pickle:

58

mkdir -p build/pickle build/doctrees

60

mkdir -p build/pickle build/doctrees

59

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

61

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

60

@echo

62

@echo

61

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

63

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

62

@echo " sphinx-web build/pickle"

64

@echo " sphinx-web build/pickle"

63

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

65

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

64

66

65

web: pickle

67

web: pickle

66

68

67

htmlhelp:

69

htmlhelp:

68

mkdir -p build/htmlhelp build/doctrees

70

mkdir -p build/htmlhelp build/doctrees

69

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

71

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

70

@echo

72

@echo

71

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

73

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

72

".hhp project file in build/htmlhelp."

74

".hhp project file in build/htmlhelp."

73

75

74

latex:

76

latex: api

75

mkdir -p build/latex build/doctrees

77

mkdir -p build/latex build/doctrees

76

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

78

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

77

@echo

79

@echo

78

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

80

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

79

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

81

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

80

"run these through (pdf)latex."

82

"run these through (pdf)latex."

81

83

82

changes:

84

changes:

83

mkdir -p build/changes build/doctrees

85

mkdir -p build/changes build/doctrees

84

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

86

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

85

@echo

87

@echo

86

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

88

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

87

89

88

linkcheck:

90

linkcheck:

89

mkdir -p build/linkcheck build/doctrees

91

mkdir -p build/linkcheck build/doctrees

90

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

92

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

91

@echo

93

@echo

92

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

94

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

93

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

95

"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

             # Makefile for Sphinx documentation
             #
             # You can set these variables from the command line.
             SPHINXOPTS    =
             SPHINXBUILD   = sphinx-build
             PAPER         =
             SRCDIR        = source
             # Internal variables.
             PAPEROPT_a4     = -D latex_paper_size=a4
             PAPEROPT_letter = -D latex_paper_size=letter
             ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
             .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
             default: html
             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"
             	@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/"
             clean:
             	-rm -rf build/* dist/* $(SRCDIR)/api/generated
             pdf: latex
             	cd build/latex && make all-pdf
             all: html pdf
             dist: clean all
             	mkdir -p dist
             	ln build/latex/ipython.pdf dist/
             	cp -al build/html dist/
             	@echo "Build finished.  Final docs are in dist/"
             html: api
             	mkdir -p build/html build/doctrees
             	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
             	@echo
             	@echo "Build finished. The HTML pages are in build/html."
-            api:
+            api: source/api/generated/gen.txt
+            source/api/generated/gen.txt:
             	python autogen_api.py
             	@echo "Build API docs finished."
             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:
+            latex: api
             	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."