mirror of
https://github.com/ceph/ceph
synced 2024-12-15 16:07:00 +00:00
335205bafa
because it's deprecated, and is on by default in the specified sphinx version (v1.6.3): this change silences following warning: build-doc/virtualenv/local/lib/python2.7/site-packages/sphinx/environment/__init__.py:683: RemovedInSphinx17Warning: html_use_smartypants option is deprecated. Smart quotes are on by default; if you want to disable or customize them, use the smart_quotes option in docutils.conf. RemovedInSphinx17Warning) Signed-off-by: Kefu Chai <kchai@redhat.com>
70 lines
1.9 KiB
Python
70 lines
1.9 KiB
Python
import sys
|
|
import os
|
|
|
|
project = u'Ceph'
|
|
copyright = u'2016, Red Hat, Inc, and contributors. Licensed under Creative Commons BY-SA'
|
|
version = 'dev'
|
|
release = 'dev'
|
|
|
|
templates_path = ['_templates']
|
|
source_suffix = '.rst'
|
|
master_doc = 'index'
|
|
exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst']
|
|
if tags.has('man'):
|
|
master_doc = 'man_index'
|
|
exclude_patterns += ['index.rst', 'architecture.rst', 'glossary.rst', 'release*.rst',
|
|
'api/*',
|
|
'cephfs/*',
|
|
'dev/*',
|
|
'install/*',
|
|
'mon/*',
|
|
'rados/*',
|
|
'mgr/*',
|
|
'ceph-volume/*',
|
|
'radosgw/*',
|
|
'rbd/*',
|
|
'start/*']
|
|
else:
|
|
exclude_patterns += ['man_index.rst']
|
|
|
|
pygments_style = 'sphinx'
|
|
|
|
html_theme = 'ceph'
|
|
html_theme_path = ['_themes']
|
|
html_title = "Ceph Documentation"
|
|
html_logo = 'logo.png'
|
|
html_favicon = 'favicon.ico'
|
|
html_show_sphinx = False
|
|
html_sidebars = {
|
|
'**': ['smarttoc.html', 'searchbox.html'],
|
|
}
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.graphviz',
|
|
'sphinx.ext.todo',
|
|
'sphinx_ditaa',
|
|
'breathe',
|
|
]
|
|
todo_include_todos = True
|
|
|
|
top_level = os.path.dirname(
|
|
os.path.dirname(
|
|
os.path.abspath(__file__)
|
|
)
|
|
)
|
|
|
|
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"])
|
|
}
|
|
breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'}
|
|
pybind = os.path.join(top_level, 'src/pybind')
|
|
if pybind not in sys.path:
|
|
sys.path.insert(0, pybind)
|