mirror of
https://github.com/ceph/ceph
synced 2024-12-13 15:08:33 +00:00
66ee58f691
Most of the doc is user-oriented, let's isolate internals more. Split into multiple files. Clean up RST. Use Sphinx's graphviz plugin for graphs. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
72 lines
1.9 KiB
Python
72 lines
1.9 KiB
Python
project = u'Ceph'
|
|
copyright = u'2011, New Dream Network'
|
|
version = 'dev'
|
|
release = 'dev'
|
|
|
|
templates_path = ['_templates']
|
|
source_suffix = '.rst'
|
|
master_doc = 'index'
|
|
exclude_patterns = ['**/.#*', '**/*~']
|
|
pygments_style = 'sphinx'
|
|
|
|
html_theme = 'nature'
|
|
html_title = "Ceph documentation"
|
|
html_logo = 'logo.jpg'
|
|
html_favicon = 'favicon.ico'
|
|
html_use_smartypants = True
|
|
html_show_sphinx = False
|
|
html_sidebars = {
|
|
'**': ['smarttoc.html', 'searchbox.html'],
|
|
}
|
|
|
|
# ugly kludge until breathe is distutils-friendly
|
|
import sys; sys.path.append('../build-doc/breathe')
|
|
extensions = [
|
|
'sphinx.ext.graphviz',
|
|
'sphinx.ext.todo',
|
|
'breathe',
|
|
]
|
|
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())
|
|
|
|
breathe_default_project = 'ceph'
|
|
breathe_projects = dict(
|
|
ceph='doxygen/xml',
|
|
)
|