Permalink
Browse files

make sphinx compile strictly by turning all warnings into errors

and fix up existing warnings (1.2-branch)
  • Loading branch information...
1 parent 36119a3 commit 4bc95dbdc36c4322ef12c08dc8bdf7f6ae9b3f66 michr committed Oct 1, 2011
Showing with 12 additions and 8 deletions.
  1. +1 −1 docs/Makefile
  2. +7 −4 docs/conf.py
  3. +3 −2 docs/index.rst
  4. +1 −1 docs/narr/introduction.rst
View
2 docs/Makefile
@@ -2,7 +2,7 @@
#
# You can set these variables from the command line.
-SPHINXOPTS =
+SPHINXOPTS = -W
SPHINXBUILD = sphinx-build
PAPER =
View
11 docs/conf.py
@@ -11,7 +11,8 @@
# All configuration values have a default value; values that are commented out
# serve to show the default value.
-import sys, os
+import sys
+import os
import datetime
import inspect
import warnings
@@ -389,7 +390,7 @@ def frontmatter(name, arguments, options, content, lineno,
% reset page counter
\setcounter{page}{1}
% suppress first toc pagenum
-\addtocontents{toc}{\protect\thispagestyle{empty}}
+\addtocontents{toc}{\protect\thispagestyle{empty}}
""",
format='latex')]
@@ -402,7 +403,7 @@ def mainmatter(name, arguments, options, content, lineno,
% allow part/chapter/section numbering
\setcounter{secnumdepth}{2}
% get headers back
-\pagestyle{fancy}
+\pagestyle{fancy}
\fancyhf{}
\renewcommand{\headrulewidth}{0.5pt}
\renewcommand{\footrulewidth}{0pt}
@@ -488,7 +489,9 @@ def resig(app, what, name, obj, options, signature, return_annotation):
#epub_post_files = []
# A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
+ '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js',
+ '_static/basic.css', 'search.html']
# The depth of the table of contents in toc.ncx.
epub_tocdepth = 3
View
5 docs/index.rst
@@ -229,10 +229,11 @@ Index and Glossary
* :ref:`search`
-.. add glossary in hidden toc tree so it does not complain its not included
+.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings
.. toctree::
:hidden:
glossary
-
+ foreword.rst
+ latexindex.rst
View
2 docs/narr/introduction.rst
@@ -826,7 +826,7 @@ trolls" or other people who seem to get their rocks off by berating fellow
users in our various offical support channels. We try to keep it well-lit
and new-user-friendly.
-Example: Visit irc://freenode.net#pyramid (the ``#pyramid`` channel on
+Example: Visit irc\://freenode.net#pyramid (the ``#pyramid`` channel on
irc.freenode.net in an IRC client) or the pylons-discuss maillist at
http://groups.google.com/group/pylons-discuss/ .

0 comments on commit 4bc95db

Please sign in to comment.