2014-03-24 18:23:54 +00:00
|
|
|
import sys
|
|
|
|
import os
|
|
|
|
|
2013-03-08 23:46:34 +00:00
|
|
|
project = u'Ceph'
|
2016-01-19 19:48:09 +00:00
|
|
|
copyright = u'2016, Red Hat, Inc, and contributors. Licensed under Creative Commons BY-SA'
|
2011-08-19 23:43:21 +00:00
|
|
|
version = 'dev'
|
|
|
|
release = 'dev'
|
|
|
|
|
|
|
|
templates_path = ['_templates']
|
|
|
|
source_suffix = '.rst'
|
|
|
|
master_doc = 'index'
|
2014-05-08 01:01:52 +00:00
|
|
|
exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst']
|
2016-05-24 04:53:21 +00:00
|
|
|
if tags.has('man'):
|
2017-08-15 18:11:06 +00:00
|
|
|
master_doc = 'man_index'
|
|
|
|
exclude_patterns += ['index.rst', 'architecture.rst', 'glossary.rst', 'release*.rst',
|
2016-05-24 04:53:21 +00:00
|
|
|
'api/*',
|
|
|
|
'cephfs/*',
|
|
|
|
'dev/*',
|
|
|
|
'install/*',
|
|
|
|
'mon/*',
|
|
|
|
'rados/*',
|
2017-08-15 18:11:06 +00:00
|
|
|
'mgr/*',
|
2017-08-17 21:02:43 +00:00
|
|
|
'ceph-volume/*',
|
2016-05-24 04:53:21 +00:00
|
|
|
'radosgw/*',
|
|
|
|
'rbd/*',
|
|
|
|
'start/*']
|
2017-08-15 18:42:52 +00:00
|
|
|
else:
|
|
|
|
exclude_patterns += ['man_index.rst']
|
2016-05-24 04:53:21 +00:00
|
|
|
|
2011-08-19 23:43:21 +00:00
|
|
|
pygments_style = 'sphinx'
|
|
|
|
|
2012-05-03 18:02:51 +00:00
|
|
|
html_theme = 'ceph'
|
|
|
|
html_theme_path = ['_themes']
|
2013-03-04 19:48:14 +00:00
|
|
|
html_title = "Ceph Documentation"
|
2012-05-03 18:02:51 +00:00
|
|
|
html_logo = 'logo.png'
|
2011-08-19 23:43:21 +00:00
|
|
|
html_favicon = 'favicon.ico'
|
|
|
|
html_show_sphinx = False
|
2011-08-30 18:26:56 +00:00
|
|
|
html_sidebars = {
|
|
|
|
'**': ['smarttoc.html', 'searchbox.html'],
|
|
|
|
}
|
2011-08-19 23:43:21 +00:00
|
|
|
|
2011-08-29 22:43:41 +00:00
|
|
|
extensions = [
|
2011-09-30 18:30:28 +00:00
|
|
|
'sphinx.ext.autodoc',
|
2011-09-01 19:42:56 +00:00
|
|
|
'sphinx.ext.graphviz',
|
2011-08-29 22:43:41 +00:00
|
|
|
'sphinx.ext.todo',
|
2017-09-11 13:54:33 +00:00
|
|
|
'sphinxcontrib.ditaa',
|
2015-03-17 15:40:00 +00:00
|
|
|
'breathe',
|
2011-08-29 22:43:41 +00:00
|
|
|
]
|
2017-09-11 13:54:33 +00:00
|
|
|
ditaa = 'ditaa'
|
2011-08-19 23:43:21 +00:00
|
|
|
todo_include_todos = True
|
|
|
|
|
2014-03-24 18:23:54 +00:00
|
|
|
top_level = os.path.dirname(
|
|
|
|
os.path.dirname(
|
|
|
|
os.path.abspath(__file__)
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
2015-03-17 15:40:00 +00:00
|
|
|
breathe_default_project = "Ceph"
|
|
|
|
# see $(top_srcdir)/Doxyfile
|
|
|
|
|
|
|
|
breathe_build_directory = os.path.join(top_level, "build-doc")
|
|
|
|
breathe_projects = {"Ceph": os.path.join(top_level, breathe_build_directory)}
|
|
|
|
breathe_projects_source = {
|
|
|
|
"Ceph": (os.path.join(top_level, "src/include/rados"),
|
|
|
|
["rados_types.h", "librados.h"])
|
|
|
|
}
|
2016-05-31 10:33:08 +00:00
|
|
|
breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'}
|
2014-03-24 18:23:54 +00:00
|
|
|
pybind = os.path.join(top_level, 'src/pybind')
|
|
|
|
if pybind not in sys.path:
|
|
|
|
sys.path.insert(0, pybind)
|