浏览代码

Docs: Always rebuild all docs

Previously, only calling "make clean && make html" would display all
errors and warnings in the docs. This was too slow to do by default, and
hence many errors would go unnoticed.
Adding the -a flag to Sphinx forces it to look at all the files again,
but is considerably quicker than deleting the build directory. As such,
I think it's good default behaviour as it isn't too slow even on
non-SSD machines.
master
Maik Hoepfel 11 年前
父节点
当前提交
08d78792da
共有 1 个文件被更改,包括 16 次插入16 次删除
  1. 16
    16
      docs/Makefile

+ 16
- 16
docs/Makefile 查看文件

@@ -37,38 +37,38 @@ clean:
37 37
 	-rm -rf $(BUILDDIR)/*
38 38
 
39 39
 html:
40
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
40
+	$(SPHINXBUILD) -a -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41 41
 	@echo
42 42
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43 43
 
44 44
 dirhtml:
45
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
45
+	$(SPHINXBUILD) -a -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46 46
 	@echo
47 47
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48 48
 
49 49
 singlehtml:
50
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
50
+	$(SPHINXBUILD) -a -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51 51
 	@echo
52 52
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53 53
 
54 54
 pickle:
55
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
55
+	$(SPHINXBUILD) -a -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56 56
 	@echo
57 57
 	@echo "Build finished; now you can process the pickle files."
58 58
 
59 59
 json:
60
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
60
+	$(SPHINXBUILD) -a -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61 61
 	@echo
62 62
 	@echo "Build finished; now you can process the JSON files."
63 63
 
64 64
 htmlhelp:
65
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
65
+	$(SPHINXBUILD) -a -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66 66
 	@echo
67 67
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
68 68
 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
69 69
 
70 70
 qthelp:
71
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
71
+	$(SPHINXBUILD) -a -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72 72
 	@echo
73 73
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74 74
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@@ -77,7 +77,7 @@ qthelp:
77 77
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-oscar.qhc"
78 78
 
79 79
 devhelp:
80
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
80
+	$(SPHINXBUILD) -a -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81 81
 	@echo
82 82
 	@echo "Build finished."
83 83
 	@echo "To view the help file:"
@@ -86,45 +86,45 @@ devhelp:
86 86
 	@echo "# devhelp"
87 87
 
88 88
 epub:
89
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
89
+	$(SPHINXBUILD) -a -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90 90
 	@echo
91 91
 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92 92
 
93 93
 latex:
94
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
94
+	$(SPHINXBUILD) -a -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95 95
 	@echo
96 96
 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97 97
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
98 98
 	      "(use \`make latexpdf' here to do that automatically)."
99 99
 
100 100
 latexpdf:
101
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101
+	$(SPHINXBUILD) -a -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102 102
 	@echo "Running LaTeX files through pdflatex..."
103 103
 	make -C $(BUILDDIR)/latex all-pdf
104 104
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105 105
 
106 106
 text:
107
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
107
+	$(SPHINXBUILD) -a -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108 108
 	@echo
109 109
 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
110 110
 
111 111
 man:
112
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
112
+	$(SPHINXBUILD) -a -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113 113
 	@echo
114 114
 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115 115
 
116 116
 changes:
117
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
117
+	$(SPHINXBUILD) -a -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118 118
 	@echo
119 119
 	@echo "The overview file is in $(BUILDDIR)/changes."
120 120
 
121 121
 linkcheck:
122
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
122
+	$(SPHINXBUILD) -a -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123 123
 	@echo
124 124
 	@echo "Link check complete; look for any errors in the above output " \
125 125
 	      "or in $(BUILDDIR)/linkcheck/output.txt."
126 126
 
127 127
 doctest:
128
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
128
+	$(SPHINXBUILD) -a -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129 129
 	@echo "Testing of doctests in the sources finished, look at the " \
130 130
 	      "results in $(BUILDDIR)/doctest/output.txt."

正在加载...
取消
保存