mirror of
https://github.com/ceph/ceph
synced 2024-12-27 05:53:20 +00:00
301fe6cbf2
* move rst files from doc/man/8 into man/8 * extract man_pages setting for sphinx from doc/conf.py to man/conf.py * generate all man pages in `make install` * add python-sphinx to Build-Depends * check for sphinx-build in `configure` * run changed rst files through sphinx-build in `make check` Signed-off-by: Kefu Chai <kchai@redhat.com>
53 lines
1.3 KiB
Python
53 lines
1.3 KiB
Python
import sys
|
|
import os
|
|
|
|
project = u'Ceph'
|
|
copyright = u'2010-2014, Inktank Storage, 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']
|
|
pygments_style = 'sphinx'
|
|
|
|
html_theme = 'ceph'
|
|
html_theme_path = ['_themes']
|
|
html_title = "Ceph Documentation"
|
|
html_logo = 'logo.png'
|
|
html_favicon = 'favicon.ico'
|
|
html_use_smartypants = True
|
|
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"])
|
|
}
|
|
pybind = os.path.join(top_level, 'src/pybind')
|
|
if pybind not in sys.path:
|
|
sys.path.insert(0, pybind)
|