mirror of
https://github.com/ceph/ceph
synced 2024-12-14 23:46:28 +00:00
f1d412c303
The graph in quick-ceph-deploy.rst applies to quick-start-preflight.rst. The graph in deploy seems more complete, so I put the common documentation in quick-common.rst and had it included. doc/conf.py has 'start/quick-common.rst' in exclude patterns so that sphinx does not complain about this file not being in toc. Signed-off-by: Kevin Dalley <kevin@kelphead.org>
83 lines
2.1 KiB
Python
83 lines
2.1 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',
|
|
'asphyxiate',
|
|
]
|
|
todo_include_todos = True
|
|
|
|
def _get_manpages():
|
|
import os
|
|
man_dir = os.path.join(
|
|
os.path.dirname(__file__),
|
|
'man',
|
|
)
|
|
sections = os.listdir(man_dir)
|
|
for section in sections:
|
|
section_dir = os.path.join(man_dir, section)
|
|
if not os.path.isdir(section_dir):
|
|
continue
|
|
for filename in os.listdir(section_dir):
|
|
base, ext = os.path.splitext(filename)
|
|
if ext != '.rst':
|
|
continue
|
|
if base == 'index':
|
|
continue
|
|
with file(os.path.join(section_dir, filename)) as f:
|
|
one = f.readline()
|
|
two = f.readline()
|
|
three = f.readline()
|
|
assert one == three
|
|
assert all(c=='=' for c in one.rstrip('\n'))
|
|
two = two.strip()
|
|
name, rest = two.split('--', 1)
|
|
assert name.strip() == base
|
|
description = rest.strip()
|
|
yield (
|
|
os.path.join('man', section, base),
|
|
base,
|
|
description,
|
|
'',
|
|
section,
|
|
)
|
|
|
|
man_pages = list(_get_manpages())
|
|
|
|
asphyxiate_doxygen_xml = 'doxygen'
|
|
|
|
top_level = os.path.dirname(
|
|
os.path.dirname(
|
|
os.path.abspath(__file__)
|
|
)
|
|
)
|
|
|
|
pybind = os.path.join(top_level, 'src/pybind')
|
|
if pybind not in sys.path:
|
|
sys.path.insert(0, pybind)
|