Merge pull request #3475 from Pylons/docs-pdf-build-1.9-branch

Synch up conf.py with 1.10

docs/conf.py

@@ -53,7 +53,6 @@ def nothing(*arg):
  'sphinx.ext.autodoc',
  'sphinx.ext.doctest',
  'sphinx.ext.intersphinx',
- 'sphinx.ext.todo',
  'sphinx.ext.viewcode',
  'sphinxcontrib.autoprogram',
  'pylons_sphinx_latesturl',
@@ -71,18 +70,18 @@ def nothing(*arg):
  'python': ('https://docs.python.org/3', None),
  'pytest': ('https://docs.pytest.org/en/latest/', None),
  'sphinx': ('http://www.sphinx-doc.org/en/latest', None),
- 'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
+ 'sqla': ('https://docs.sqlalchemy.org/en/latest', None),
  'tm': ('https://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None),
  'toolbar': ('https://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None),
  'tstring': ('https://docs.pylonsproject.org/projects/translationstring/en/latest', None),
  'tutorials': ('https://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None),
  'venusian': ('https://docs.pylonsproject.org/projects/venusian/en/latest', None),
  'webob': ('https://docs.pylonsproject.org/projects/webob/en/latest/', None),
- 'webtest': ('http://webtest.pythonpaste.org/en/latest', None),
- 'who': ('http://repozewho.readthedocs.io/en/latest', None),
+ 'webtest': ('https://docs.pylonsproject.org/projects/webtest/en/latest/', None),
+ 'who': ('https://repozewho.readthedocs.io/en/latest', None),
  'zcml': ('https://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', None),
- 'zcomponent': ('http://zopecomponent.readthedocs.io/en/latest/', None),
- 'zinterface': ('http://zopeinterface.readthedocs.io/en/latest/', None),
+ 'zcomponent': ('https://zopecomponent.readthedocs.io/en/latest/', None),
+ 'zinterface': ('https://zopeinterface.readthedocs.io/en/latest/', None),
 }
 
 
@@ -123,9 +122,6 @@ def nothing(*arg):
 # unit titles (such as .. function::).
 add_module_names = False
 
-# Add support for todo items
-todo_include_todos = True
-
 # The name of the Pygments (syntax highlighting) style to use.
 #pygments_style = book and 'bw' or 'tango'
 if book:
@@ -199,7 +195,10 @@ def nothing(*arg):
 # The font size ('10pt', '11pt' or '12pt').
 latex_font_size = '10pt'
 
-latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png']
+latex_additional_files = [
+ '_static/latex-note.png',
+ '_static/latex-warning.png',
+]
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
@@ -229,6 +228,17 @@ def nothing(*arg):
 _PREAMBLE = r"""
 \usepackage[]{geometry}
 \geometry{bindingoffset=0.45in,textheight=7.25in,hdivide={0.5in,*,0.75in},vdivide={1in,7.25in,1in},papersize={7.5in,9.25in}}
+
+%XeLaTeX packages
+\usepackage{xltxtra}
+\usepackage{fontspec} %Font package
+\usepackage{xunicode}
+
+%Select fonts
+\setmainfont[Mapping=tex-text]{nimbusserif}
+\setsansfont[Mapping=tex-text]{nimbussans}
+\setmonofont{nimbusmono}
+
 \hypersetup{
  colorlinks=true,
  linkcolor=black,
@@ -285,28 +295,22 @@ def nothing(*arg):
 \definecolor{VerbatimColor}{rgb}{1,1,1}
 \definecolor{VerbatimBorderColor}{rgb}{1,1,1}
 
-\makeatletter
-\renewcommand{\py@noticestart@warning}{\py@heavybox}
-\renewcommand{\py@noticeend@warning}{\py@endheavybox}
-\renewcommand{\py@noticestart@note}{\py@heavybox}
-\renewcommand{\py@noticeend@note}{\py@endheavybox}
-\makeatother
-
 % icons in note and warning boxes
 \usepackage{ifthen}
-% Keep a copy of the original notice environment
-\let\origbeginnotice\notice
-\let\origendnotice\endnotice
 
-% Redefine the notice environment so we can add our own code to it
-\renewenvironment{notice}[2]{%
- \origbeginnotice{#1}{}% equivalent to original \begin{notice}{#1}{#2}
+% Keep a copy of the original sphinxadmonition environment
+\let\origbeginadmon\sphinxadmonition
+\let\origendadmon\endsphinxadmonition
+
+% Redefine the sphinxadmonition environment so we can add our own code to it
+\renewenvironment{sphinxadmonition}[2]{%
+ \origbeginadmon{#1}{}% equivalent to original \begin{sphinxadmonition}{#1}{#2}
  % load graphics
  \ifthenelse{\equal{#1}{warning}}{\includegraphics{latex-warning.png}}{}
  \ifthenelse{\equal{#1}{note}}{\includegraphics{latex-note.png}}{}
  % etc.
-}{%
- \origendnotice% equivalent to original \end{notice}
+ }{%
+\origendadmon % equivalent to original \end{sphinxadmonition}
 }
 
 % try to prevent code-block boxes from splitting across pages
@@ -350,44 +354,21 @@ def frontmatter(name, arguments, options, content, lineno,
  content_offset, block_text, state, state_machine):
  return [nodes.raw(
  '',
- r"""
-\frontmatter
-% prevent part/chapter/section numbering
-\setcounter{secnumdepth}{-2}
-% suppress headers
-\pagestyle{plain}
-% reset page counter
-\setcounter{page}{1}
-% suppress first toc pagenum
-\addtocontents{toc}{\protect\thispagestyle{empty}}
-""",
  format='latex')]
 
 
 def mainmatter(name, arguments, options, content, lineno,
  content_offset, block_text, state, state_machine):
  return [nodes.raw(
  '',
- r"""
-\mainmatter
-% allow part/chapter/section numbering
-\setcounter{secnumdepth}{2}
-% get headers back
-\pagestyle{fancy}
-\fancyhf{}
-\renewcommand{\headrulewidth}{0.5pt}
-\renewcommand{\footrulewidth}{0pt}
-\fancyfoot[C]{\thepage}
-\fancyhead[RO]{\rightmark}
-\fancyhead[LE]{\leftmark}
-""",
  format='latex')]
 
 
 def backmatter(name, arguments, options, content, lineno,
  content_offset, block_text, state, state_machine):
- return [nodes.raw('', '\\backmatter\n\\setcounter{secnumdepth}{-1}\n',
- format='latex')]
+ return [nodes.raw(
+ '',
+ format='latex')]
 
 
 def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
@@ -465,3 +446,11 @@ def resig(app, what, name, obj, options, signature, return_annotation):
 epub_tocdepth = 3
 
 # For a list of all settings, visit http://sphinx-doc.org/config.html
+
+# -- Options for linkcheck builder -------------------------------------------
+
+# List of items to ignore when running linkcheck
+linkcheck_ignore = [
+ r'http://localhost:\d+',
+ r'http://localhost',
+]

docs/typographical-conventions.rst

@@ -265,18 +265,6 @@ See also
  See :ref:`Quick Tutorial section on Requirements <qtut_requirements>`.
 
 
-.. _typographical-conventions-todo:
-
-Todo
-----
-
-Todo items designated tasks that require further work.
-
-.. todo::
-
- This is a todo item.
-
-
 .. _typographical-conventions-cross-references:
 
 Cross-references