mirror of
https://github.com/ceph/ceph
synced 2024-12-16 08:26:25 +00:00
6dd570476c
this change will enable us to specify `:orphan:` in the fieldlist of a manpage rst file, otherwise sphinx-build complains at seeing it if it is not referenced by a toc doc. Signed-off-by: Kefu Chai <kchai@redhat.com>
59 lines
1.7 KiB
Python
59 lines
1.7 KiB
Python
import os
|
|
|
|
project = u'Ceph'
|
|
copyright = u'2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA'
|
|
version = 'dev'
|
|
release = 'dev'
|
|
|
|
exclude_patterns = ['**/.#*', '**/*~']
|
|
|
|
def _get_description(fname):
|
|
with file(fname) as f:
|
|
one = None
|
|
for line in f:
|
|
line = line.rstrip('\n')
|
|
if not line:
|
|
continue
|
|
if line.startswith(':') and line.endswith(':'):
|
|
continue
|
|
one = line
|
|
break
|
|
two = f.readline()
|
|
three = f.readline()
|
|
print one, three
|
|
assert one == three
|
|
assert all(c=='=' for c in one.rstrip('\n'))
|
|
two = two.strip()
|
|
name, description = two.split('--', 1)
|
|
assert name.strip() == base
|
|
return description.strip()
|
|
|
|
def _get_manpages():
|
|
src_dir = os.path.dirname(__file__)
|
|
top_srcdir = os.path.dirname(src_dir)
|
|
man_dir = os.path.join(top_srcdir, 'doc', '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
|
|
description = os.path.join(section_dir, filename)
|
|
yield (
|
|
os.path.join(section, base),
|
|
base,
|
|
description,
|
|
'',
|
|
section,
|
|
)
|
|
|
|
man_pages = list(_get_manpages())
|
|
# sphinx warns if no toc is found, so feed it with a random file
|
|
# which is also rendered in this run.
|
|
master_doc = '8/ceph'
|