]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | import sys |
2 | import os | |
3 | ||
4 | project = u'Ceph' | |
94b18763 | 5 | copyright = u'2016, Red Hat, Inc, and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)' |
7c673cae FG |
6 | version = 'dev' |
7 | release = 'dev' | |
8 | ||
9 | templates_path = ['_templates'] | |
10 | source_suffix = '.rst' | |
11 | master_doc = 'index' | |
12 | exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst'] | |
13 | if 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 | ||
27 | pygments_style = 'sphinx' | |
28 | ||
29 | html_theme = 'ceph' | |
30 | html_theme_path = ['_themes'] | |
31 | html_title = "Ceph Documentation" | |
32 | html_logo = 'logo.png' | |
33 | html_favicon = 'favicon.ico' | |
34 | html_use_smartypants = True | |
35 | html_show_sphinx = False | |
f64942e4 | 36 | html_static_path = ["_static"] |
7c673cae FG |
37 | html_sidebars = { |
38 | '**': ['smarttoc.html', 'searchbox.html'], | |
39 | } | |
40 | ||
f64942e4 AA |
41 | sys.path.insert(0, os.path.abspath('_ext')) |
42 | ||
7c673cae FG |
43 | extensions = [ |
44 | 'sphinx.ext.autodoc', | |
45 | 'sphinx.ext.graphviz', | |
46 | 'sphinx.ext.todo', | |
3efd9988 | 47 | 'sphinxcontrib.ditaa', |
7c673cae | 48 | 'breathe', |
f64942e4 | 49 | 'edit_on_github', |
7c673cae | 50 | ] |
3efd9988 | 51 | ditaa = 'ditaa' |
7c673cae FG |
52 | todo_include_todos = True |
53 | ||
54 | top_level = os.path.dirname( | |
55 | os.path.dirname( | |
56 | os.path.abspath(__file__) | |
57 | ) | |
58 | ) | |
59 | ||
60 | breathe_default_project = "Ceph" | |
61 | # see $(top_srcdir)/Doxyfile | |
62 | ||
63 | breathe_build_directory = os.path.join(top_level, "build-doc") | |
64 | breathe_projects = {"Ceph": os.path.join(top_level, breathe_build_directory)} | |
65 | breathe_projects_source = { | |
66 | "Ceph": (os.path.join(top_level, "src/include/rados"), | |
67 | ["rados_types.h", "librados.h"]) | |
68 | } | |
69 | breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'} | |
70 | pybind = os.path.join(top_level, 'src/pybind') | |
71 | if pybind not in sys.path: | |
72 | sys.path.insert(0, pybind) | |
f64942e4 AA |
73 | |
74 | # the docs are rendered with github links pointing to master. the javascript | |
75 | # snippet in _static/ceph.js rewrites the edit links when a page is loaded, to | |
76 | # point to the correct branch. | |
77 | edit_on_github_project = 'ceph/ceph' | |
78 | edit_on_github_branch = 'master' | |
79 | ||
80 | # handles edit-on-github and old version warning display | |
81 | def setup(app): | |
82 | app.add_javascript('js/ceph.js') |