summaryrefslogtreecommitdiff
path: root/docs/conf.py.in
blob: b08493b34fafe542045ad6a75fcd8f0065e41ca6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# -*- coding: utf-8 -*-

# See:
# http://sphinx.pocoo.org/config.html

import sys, os

# -- Add PyOpenColorIO to sys.path
sys.path.insert(0, "@CMAKE_BINARY_DIR@/src/pyglue")

# -- General configuration -----------------------------------------------------
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig']
templates_path = ['templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'OpenColorIO'
copyright = u'2010, Sony Pictures Imageworks'
# The short X.Y version.
version = '@OCIO_VERSION_MAJOR@.@OCIO_VERSION_MINOR@'
# The full version, including alpha/beta/rc tags.
release = '@OCIO_VERSION@'
exclude_patterns = ['build', '*-prefix']
#add_function_parentheses = True
#add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
#modindex_common_prefix = []

rst_prolog = """
.. |OCIO| replace:: *OCIO*
.. |OpenColorIO| replace:: **OpenColorIO**
.. _Sony Imageworks: http://www.imageworks.com/
.. |Sony Imageworks| replace:: `Sony Imageworks`_
.. _Jeremy Selan: mailto:jeremy.selan@gmail.com
.. |Jeremy Selan| replace:: `Jeremy Selan`_
.. _ocio-users: http://groups.google.com/group/ocio-users
.. _ocio-dev: http://groups.google.com/group/ocio-dev
"""

# -- Options for HTML output ---------------------------------------------------
html_theme_path = ['.']
html_theme = 'ociotheme'
#html_theme_options = {}
#html_title = None
#html_short_title = None
#html_logo = None
#html_favicon = None
html_static_path = []
#html_last_updated_fmt = '%b %d, %Y'
#html_use_smartypants = True
#html_sidebars = {}
#html_additional_pages = {}
html_domain_indices = ['cpp-modindex', 'py-modindex']
#html_use_index = True
#html_split_index = False
#html_show_sourcelink = True
#html_show_sphinx = True
#html_show_copyright = True
#html_use_opensearch = ''
#html_file_suffix = None
htmlhelp_basename = 'OpenColorIOdoc'

# -- Options for LaTeX output --------------------------------------------------
#latex_paper_size = 'letter'
#latex_font_size = '10pt'
latex_documents = [
  ('index', 'OpenColorIO.tex', u'OpenColorIO Documentation',
   u'Sony Pictures Imageworks', 'manual', False),
]
latex_elements = {
  'preamble': '\setcounter{tocdepth}{2}',
  'footer': 'test...123'
}

#latex_logo = None
#latex_use_parts = False
#latex_show_pagerefs = False
#latex_show_urls = False
#latex_preamble = '\setcounter{tocdepth}{2}'
#latex_appendices = []
latex_domain_indices = ['cpp-modindex', 'py-modindex']

# -- Options for manual page output --------------------------------------------
man_pages = [
    ('index', 'opencolorio', u'OpenColorIO Documentation',
    [u'Sony Pictures Imageworks'], 1)
]

# -- Options for Texinfo output ------------------------------------------------
texinfo_documents = [
  ('index', 'OpenColorIO', u'OpenColorIO Documentation', u'Sony Pictures Imageworks',
   'OpenColorIO', 'One line description of project.', 'Miscellaneous'),
]
texinfo_appendices = []

# -- Options for Epub output ---------------------------------------------------
epub_title = u'OpenColorIO'
epub_author = u'Sony Pictures Imageworks'
epub_publisher = u'Sony Pictures Imageworks'
epub_copyright = u'2010, Sony Pictures Imageworks'
#epub_language = ''
#epub_scheme = ''
#epub_identifier = ''
#epub_uid = ''
#epub_cover = ()
#epub_pre_files = []
#epub_post_files = []
#epub_exclude_files = []
#epub_tocdepth = 3
#epub_tocdup = True