]> git.proxmox.com Git - ceph.git/blame - ceph/doc/conf.py
update sources to v12.2.0
[ceph.git] / ceph / doc / conf.py
CommitLineData
7c673cae
FG
1import sys
2import os
3
4project = u'Ceph'
5copyright = u'2016, Red Hat, Inc, and contributors. Licensed under Creative Commons BY-SA'
6version = 'dev'
7release = 'dev'
8
9templates_path = ['_templates']
10source_suffix = '.rst'
11master_doc = 'index'
12exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst']
13if tags.has('man'):
14 exclude_patterns += ['architecture.rst', 'glossary.rst', 'release*.rst',
15 'api/*',
16 'cephfs/*',
17 'dev/*',
18 'install/*',
19 'mon/*',
20 'rados/*',
b5b8bbf5
FG
21 'mgr/*',
22 'ceph-volume/*',
7c673cae
FG
23 'radosgw/*',
24 'rbd/*',
25 'start/*']
26
27pygments_style = 'sphinx'
28
29html_theme = 'ceph'
30html_theme_path = ['_themes']
31html_title = "Ceph Documentation"
32html_logo = 'logo.png'
33html_favicon = 'favicon.ico'
34html_use_smartypants = True
35html_show_sphinx = False
36html_sidebars = {
37 '**': ['smarttoc.html', 'searchbox.html'],
38 }
39
40extensions = [
41 'sphinx.ext.autodoc',
42 'sphinx.ext.graphviz',
43 'sphinx.ext.todo',
44 'sphinx_ditaa',
45 'breathe',
46 ]
47todo_include_todos = True
48
49top_level = os.path.dirname(
50 os.path.dirname(
51 os.path.abspath(__file__)
52 )
53)
54
55breathe_default_project = "Ceph"
56# see $(top_srcdir)/Doxyfile
57
58breathe_build_directory = os.path.join(top_level, "build-doc")
59breathe_projects = {"Ceph": os.path.join(top_level, breathe_build_directory)}
60breathe_projects_source = {
61 "Ceph": (os.path.join(top_level, "src/include/rados"),
62 ["rados_types.h", "librados.h"])
63}
64breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'}
65pybind = os.path.join(top_level, 'src/pybind')
66if pybind not in sys.path:
67 sys.path.insert(0, pybind)