src/doc/sphinx/conf.py (6147B) - raw
1 # -*- coding: utf-8 -*-
2 #
3 # rdftemplate documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jul 28 08:11:55 2010.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('.'))
20 sys.path.insert(0, '/home/dan/miskinhill/sphinx-contrib/javadomain')
21 sys.path.insert(0, '/home/dan/miskinhill/sphinx-contrib/javadocref')
22
23 import lxml.etree
24 pom = lxml.etree.parse(open(os.path.join('..', '..', '..', 'pom.xml')))
25 def pom_xpath(expr):
26 return lxml.etree.XPath(expr, namespaces={'pom': 'http://maven.apache.org/POM/4.0.0'})(pom)
27
28 # -- General configuration -----------------------------------------------------
29
30 # If your documentation needs a minimal Sphinx version, state it here.
31 #needs_sphinx = '1.0'
32
33 # Add any Sphinx extension module names here, as strings. They can be extensions
34 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35 extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.graphviz',
36 'sphinxcontrib.javadomain', 'sphinxcontrib.javadocref']
37
38 # Add any paths that contain templates here, relative to this directory.
39 templates_path = ['_templates']
40
41 # The suffix of source filenames.
42 source_suffix = '.rst'
43
44 # The encoding of source files.
45 #source_encoding = 'utf-8-sig'
46
47 # The master toctree document.
48 master_doc = 'index'
49
50 # General information about the project.
51 project = pom_xpath('//pom:project/pom:name/text()')[0]
52 copyright = u'2010, Dan Callaghan'
53
54 # The version info for the project you're documenting, acts as replacement for
55 # |version| and |release|, also used in various other places throughout the
56 # built documents.
57 #
58 # The short X.Y version.
59 version = pom_xpath('//pom:project/pom:version/text()')[0]
60 # The full version, including alpha/beta/rc tags.
61 release = pom_xpath('//pom:project/pom:version/text()')[0]
62
63 # The language for content autogenerated by Sphinx. Refer to documentation
64 # for a list of supported languages.
65 #language = None
66
67 # There are two options for replacing |today|: either, you set today to some
68 # non-false value, then it is used:
69 #today = ''
70 # Else, today_fmt is used as the format for a strftime call.
71 #today_fmt = '%B %d, %Y'
72
73 # List of patterns, relative to source directory, that match files and
74 # directories to ignore when looking for source files.
75 exclude_patterns = []
76
77 # The reST default role (used for this markup: `text`) to use for all documents.
78 #default_role = None
79
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 #add_function_parentheses = True
82
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 #add_module_names = True
86
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
89 #show_authors = False
90
91 highlight_language = 'java'
92
93 # The name of the Pygments (syntax highlighting) style to use.
94 pygments_style = 'sphinx'
95
96 # A list of ignored prefixes for module index sorting.
97 #modindex_common_prefix = []
98
99
100 # -- Options for HTML output ---------------------------------------------------
101
102 # The theme to use for HTML and HTML Help pages. See the documentation for
103 # a list of builtin themes.
104 html_theme = 'basic'
105
106 # Theme options are theme-specific and customize the look and feel of a theme
107 # further. For a list of options available for each theme, see the
108 # documentation.
109 #html_theme_options = {}
110
111 # Add any paths that contain custom themes here, relative to this directory.
112 #html_theme_path = []
113
114 html_style = 'default.css'
115
116 # The name for this set of Sphinx documents. If None, it defaults to
117 # "<project> v<release> documentation".
118 html_title = project
119
120 # A shorter title for the navigation bar. Default is the same as html_title.
121 #html_short_title = None
122
123 # The name of an image file (within the static path) to use as favicon of the
124 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
125 # pixels large.
126 #html_favicon = None
127
128 # Add any paths that contain custom static files (such as style sheets) here,
129 # relative to this directory. They are copied after the builtin static files,
130 # so a file named "default.css" will overwrite the builtin "default.css".
131 html_static_path = ['_static']
132
133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134 # using the given strftime format.
135 #html_last_updated_fmt = '%b %d, %Y'
136
137 # If true, SmartyPants will be used to convert quotes and dashes to
138 # typographically correct entities.
139 html_use_smartypants = False
140
141 # Custom sidebar templates, maps document names to template names.
142 html_sidebars = {
143 'index': ['searchbox.html'],
144 'selector': ['localtoc.html', 'searchbox.html'],
145 'xml-template': ['localtoc.html', 'searchbox.html'],
146 'spring': ['localtoc.html', 'searchbox.html'],
147 }
148
149 # Additional templates that should be rendered to pages, maps page names to
150 # template names.
151 #html_additional_pages = {}
152
153 # If false, no module index is generated.
154 html_domain_indices = True
155
156 # If false, no index is generated.
157 html_use_index = False
158
159 # If true, links to the reST sources are added to the pages.
160 html_show_sourcelink = False
161
162 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
163 #html_show_sphinx = True
164
165 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
166 #html_show_copyright = True
167
168 # This is the file name suffix for HTML files (e.g. ".xhtml").
169 #html_file_suffix = None
170
171 todo_include_todos = True
172 nitpicky = True
173 javadocref_locations = ['http://code.djc.id.au/rdftemplate/javadoc/latest/',
174 'http://jena.sourceforge.net/javadoc/',
175 'http://download-llnw.oracle.com/javase/6/docs/api/']