On Jun 20, 2010, at 8:20 AM, Georg Brandl wrote:
Am 20.06.2010 14:06, schrieb Doug Hellmann:
On Jun 20, 2010, at 6:21 AM, Georg Brandl wrote:
Am 18.06.2010 16:14, schrieb Doug Hellmann:
The cross-references work great as hyperlinks if you're reading a
PDF
online, but the printed manuals just say "Some Section Heading" and
don't help the reader *find* that section.
Yes, this is a new feature in 1.0 -- set the config value
latex_show_pagerefs to True and you will have page numbers for
references in LaTeX output.
OK, thanks. I'm still on 0.6.4 because of a dependency on an
extension, so I guess this means I should port it to 1.0. :-)
If you get stuck with it, just give me a call. :)
OK, I got the extension working (it was just an import change related
to moving code around for the new domains feature).
However, when I turn on latex_show_pagerefs, I get:
! Undefined control sequence.
l.184 ...:json-api]{\emph{JSON API}} (\autopageref
*{oem_guide/
web_service/js...
The document I'm working on isn't something I can give you, so before
I spend time setting up enough of an example to reproduce the problem
I thought I'd check to see if this was a known issue in 1.0b2, if
there are other settings I need to enable, etc. I've attached my
conf.py file in case that's enough to debug with.
Thanks,
Doug
# -*- coding: utf-8 -*-
#
# $Id: conf.py 43100 2010-06-30 19:38:40Z dhellmann $
#
# DynaCenter documentation build configuration file, created by
# sphinx-quickstart on Fri Aug 29 17:27:37 2008.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
#
# All configuration values have a default value; values that are commented out
# serve to show the default value.
# Ignore deprecation warnings
import warnings
warnings.filterwarnings('ignore', '.*module is deprecated.*')
import glob
import os
import sys
# print 'PATH:', sys.path
# General configuration
# ---------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'tgwsdoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General substitutions.
project = 'DynaCenter'
copyright = '2008, Racemi'
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
version = '.'.join(version_vars['VERSION'].split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = version_vars['VERSION'] + '-' + version_vars['RELEASE'] + version_vars['UPDATE']
copyright = version_vars['COPYRIGHT'] + ' -- CONFIDENTIAL'
# Remove the word "Copyright" since the template includes it
if copyright.startswith('Copyright'):
copyright = copyright[9:].strip()
# If this is a draft, mark it as such.
if int(os.environ.get('DRAFT', 0)):
release += '-DRAFT'
copyright += ' -- DRAFT, DO NOT RELEASE'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
# (Do not include the filename extension.)
unused_docs = [
]
# Ignore the dccmd files missing from a toctree since we use
# the include directive to pull them in to the appropriate
# places.
def ignore_docs_in_dir(d):
unused_docs.extend(
os.path.splitext(n)[0]
for n in glob.glob(d + '/*.rst')
)
ignore_docs_in_dir('oem_guide/dccmd')
# List of directories, relative to source directories, that shouldn't be searched
# for source files.
exclude_dirs = [ ]
exclude_trees = [ 'attic' ]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
#pygments_style = 'sphinx'
pygments_style = 'borland'
# Substitutions
rst_epilog = '''
'''
# Options for HTML output
# -----------------------
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
html_style = 'racemi.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (within the static path) to place at the top of
# the sidebar.
html_logo = '_static/logo.jpg'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static',
doc_path,
]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
html_use_modindex = False
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
#html_copy_source = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'DynaCenterdoc'
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
def mk_tex_filename(base):
file_version = version.replace('.', '-')
return ''.join([base, '-', file_version, '.tex'])
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual], toctree_only).
latex_documents = [
('oem_guide/index', mk_tex_filename('DynaCenter-OEM'),
'DynaCenter OEM Integration Guide',
'Racemi', 'manual', True),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = '_static/logo.jpg'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
TURN_OFF_RIGHT_JUSTIFICATION = r'''\usepackage{ragged2e}
\raggedright
'''
latex_elements = {
# 'preamble':TURN_OFF_RIGHT_JUSTIFICATION,
'tableofcontents':r"""
\renewcommand{\abstractname}{Notice}
\begin{abstract}
The information contained in this publication is subject to change without notice.
Racemi, Inc. makes no warranty with regard to this material. Racemi, Inc. assumes no
liability for errors contained herein or for incidental or consequential damages in
connection with the furnishing or use of this material.
\copyright 2001 - 2010 by Racemi, Inc.
All rights reserved. No part of this document may be reproduced or transmitted in any
form of by any means, electronic, mechanical, photocopying, recording, or otherwise,
without prior written permission of Racemi, Inc.
\end{abstract}
\tableofcontents
"""}
# Documents to append as an appendix to all manuals.
latex_appendices = [
'oem_guide/glossary',
'oem_guide/support',
]
# If false, no module index is generated.
latex_use_modindex = False
# If true, show page references after internal links.
latex_show_pagerefs = True
# If true, show URL addresses after external links.
#latex_show_urls = True
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
