diff --git a/sphinx/builder.py b/sphinx/builder.py index 0f3d1f5d8..0303b3e00 100644 --- a/sphinx/builder.py +++ b/sphinx/builder.py @@ -392,7 +392,8 @@ class StandaloneHTMLBuilder(Builder): # the sorted list of all modules, for the global module index modules = sorted(((mn, (self.get_relative_uri('modindex', fn) + '#module-' + mn, sy, pl, dep)) - for (mn, (fn, sy, pl, dep)) in self.env.modules.iteritems()), + for (mn, (fn, sy, pl, dep)) in + self.env.modules.iteritems()), key=lambda x: x[0].lower()) # collect all platforms platforms = set() diff --git a/sphinx/environment.py b/sphinx/environment.py index 6e08cc2e6..0dea7ee0d 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -327,7 +327,8 @@ class BuildEnvironment: added.add(docname) else: # if the doctree file is not there, rebuild - if not path.isfile(self.doc2path(docname, self.doctreedir, '.doctree')): + if not path.isfile(self.doc2path(docname, self.doctreedir, + '.doctree')): changed.add(docname) continue mtime, md5sum = self.all_docs[docname] @@ -376,7 +377,8 @@ class BuildEnvironment: self.read_doc(docname, app=app) if config.master_doc not in self.all_docs: - self.warn(None, 'master file %s not found' % self.doc2path(config.master_doc)) + self.warn(None, 'master file %s not found' % + self.doc2path(config.master_doc)) # --------- SINGLE FILE BUILDING ------------------------------------------- diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 2423502f3..a46f0c449 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -104,7 +104,7 @@ class PygmentsBridge(object): # maybe Python -- try parsing it src = source + '\n' - # Replace "..." by a special mark, which is also a valid python expression + # Replace "..." by a mark which is also a valid python expression # (Note, the highlighter gets the original source, this is only done # to allow "..." in code and still highlight it as Python code.) mark = "__highlighting__ellipsis__" @@ -133,7 +133,8 @@ class PygmentsBridge(object): fmter = (self.dest == 'html' and self.hfmter or self.lfmter)[bool(linenos)] return highlight(source, lexer, fmter) except ErrorToken: - # this is most probably not the selected language, so let it pass unhighlighted + # this is most probably not the selected language, + # so let it pass unhighlighted return unhighlighted() def get_stylesheet(self): diff --git a/sphinx/latexwriter.py b/sphinx/latexwriter.py index 8e27bd19f..333f4159b 100644 --- a/sphinx/latexwriter.py +++ b/sphinx/latexwriter.py @@ -100,7 +100,8 @@ class LaTeXTranslator(nodes.NodeVisitor): 'release': builder.config.release, 'date': date, } - self.highlighter = highlighting.PygmentsBridge('latex', builder.config.pygments_style) + self.highlighter = highlighting.PygmentsBridge( + 'latex', builder.config.pygments_style) self.context = [] self.descstack = [] self.highlightlang = 'python' diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py index 5e1ecb9d3..eac6a66e8 100644 --- a/sphinx/quickstart.py +++ b/sphinx/quickstart.py @@ -187,58 +187,58 @@ ALLSPHINXOPTS = -d %(rbuilddir)s/doctrees -D latex_paper_size=$(PAPER) \\ .PHONY: help clean html web htmlhelp latex changes linkcheck help: - @echo "Please use \\`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " web to make files usable by 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" +\t@echo "Please use \\`make ' where is one of" +\t@echo " html to make standalone HTML files" +\t@echo " web to make files usable by Sphinx.web" +\t@echo " htmlhelp to make HTML files and a HTML help project" +\t@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" +\t@echo " changes to make an overview over all changed/added/deprecated items" +\t@echo " linkcheck to check all external links for integrity" clean: - -rm -rf %(rbuilddir)s/* +\t-rm -rf %(rbuilddir)s/* html: - mkdir -p %(rbuilddir)s/html %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) %(rbuilddir)s/html - @echo - @echo "Build finished. The HTML pages are in %(rbuilddir)s/html." +\tmkdir -p %(rbuilddir)s/html %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) %(rbuilddir)s/html +\t@echo +\t@echo "Build finished. The HTML pages are in %(rbuilddir)s/html." web: - mkdir -p %(rbuilddir)s/web %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) %(rbuilddir)s/web - @echo - @echo "Build finished; now you can run" - @echo " python -m sphinx.web %(rbuilddir)s/web" - @echo "to start the server." +\tmkdir -p %(rbuilddir)s/web %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) %(rbuilddir)s/web +\t@echo +\t@echo "Build finished; now you can run" +\t@echo " python -m sphinx.web %(rbuilddir)s/web" +\t@echo "to start the server." htmlhelp: - mkdir -p %(rbuilddir)s/htmlhelp %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) %(rbuilddir)s/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \\ - ".hhp project file in %(rbuilddir)s/htmlhelp." +\tmkdir -p %(rbuilddir)s/htmlhelp %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) %(rbuilddir)s/htmlhelp +\t@echo +\t@echo "Build finished; now you can run HTML Help Workshop with the" \\ +\t ".hhp project file in %(rbuilddir)s/htmlhelp." latex: - mkdir -p %(rbuilddir)s/latex %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) %(rbuilddir)s/latex - @echo - @echo "Build finished; the LaTeX files are in %(rbuilddir)s/latex." - @echo "Run \\`make all-pdf' or \\`make all-ps' in that directory to" \\ - "run these through (pdf)latex." +\tmkdir -p %(rbuilddir)s/latex %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) %(rbuilddir)s/latex +\t@echo +\t@echo "Build finished; the LaTeX files are in %(rbuilddir)s/latex." +\t@echo "Run \\`make all-pdf' or \\`make all-ps' in that directory to" \\ +\t "run these through (pdf)latex." changes: - mkdir -p %(rbuilddir)s/changes %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) %(rbuilddir)s/changes - @echo - @echo "The overview file is in %(rbuilddir)s/changes." +\tmkdir -p %(rbuilddir)s/changes %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) %(rbuilddir)s/changes +\t@echo +\t@echo "The overview file is in %(rbuilddir)s/changes." linkcheck: - mkdir -p %(rbuilddir)s/linkcheck %(rbuilddir)s/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) %(rbuilddir)s/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \\ - "or in %(rbuilddir)s/linkcheck/output.txt." +\tmkdir -p %(rbuilddir)s/linkcheck %(rbuilddir)s/doctrees +\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) %(rbuilddir)s/linkcheck +\t@echo +\t@echo "Link check complete; look for any errors in the above output " \\ +\t "or in %(rbuilddir)s/linkcheck/output.txt." ''' diff --git a/sphinx/templates/layout.html b/sphinx/templates/layout.html index 45ede4b1f..b2862c236 100644 --- a/sphinx/templates/layout.html +++ b/sphinx/templates/layout.html @@ -86,7 +86,7 @@ {%- block beforerelbar %}{% endblock %} -{%- block relbar1 %}{{ relbar() }}{% endblock %} +{%- block relbar1 %}{{ relbar() }}{% endblock %} {%- block afterrelbar %}{% endblock %} {%- block beforesidebar1 %}{% endblock %} @@ -114,7 +114,7 @@
-{%- block relbar2 %}{{ relbar() }}{% endblock %} +{%- block relbar2 %}{{ relbar() }}{% endblock %} {%- block beforefooter %}{% endblock %} {%- block footer %} diff --git a/utils/check_sources.py b/utils/check_sources.py index 761f05ae0..525256076 100755 --- a/utils/check_sources.py +++ b/utils/check_sources.py @@ -139,7 +139,7 @@ def check_fileheader(fn, lines): yield 0, "no correct copyright info" -@checker('.py', '.html', '.js') +@checker('.py', '.html') def check_whitespace_and_spelling(fn, lines): for lno, line in enumerate(lines): if "\t" in line: