diff options
| author | michr <michr@webhippo.net> | 2011-09-29 02:03:33 -0700 |
|---|---|---|
| committer | michr <michr@webhippo.net> | 2011-09-29 02:03:33 -0700 |
| commit | c8b363e547635e92a78c5718e9f17a5e8f55dc7f (patch) | |
| tree | b65d3371f988954cf8844bc34c3314804564278c /docs | |
| parent | b9407996975e3504f2518359640139ab51fa9c38 (diff) | |
| download | pyramid-c8b363e547635e92a78c5718e9f17a5e8f55dc7f.tar.gz pyramid-c8b363e547635e92a78c5718e9f17a5e8f55dc7f.tar.bz2 pyramid-c8b363e547635e92a78c5718e9f17a5e8f55dc7f.zip | |
avoid warning for latexindex, foreword by putting them in a hidden toc
from now on complie docs strictly, turning warnings to errors
exclude unnecssary static js files when compiling ePub
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/conf.py | 12 | ||||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/narr/introduction.rst | 2 |
4 files changed, 13 insertions, 7 deletions
diff --git a/docs/Makefile b/docs/Makefile index 1d032cf45..92dc56fda 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = diff --git a/docs/conf.py b/docs/conf.py index a5eaeb0fb..c78285840 100644 --- a/docs/conf.py +++ b/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,10 @@ epub_uid = 'The Pyramid Web Application Development Framework, Version 1.2' #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 diff --git a/docs/index.rst b/docs/index.rst index 25aaab7af..e4de8b0c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -229,10 +229,12 @@ 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 diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index 823c1ea13..8f0533997 100644 --- a/docs/narr/introduction.rst +++ b/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/ . |
