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
