diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
commit | 483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch) | |
tree | e5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /man/conf.py | |
parent | Initial commit. (diff) | |
download | ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip |
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/conf.py')
-rw-r--r-- | man/conf.py | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/man/conf.py b/man/conf.py new file mode 100644 index 00000000..6eb3faa8 --- /dev/null +++ b/man/conf.py @@ -0,0 +1,61 @@ +import os + +project = u'Ceph' +copyright = u'2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)' +version = 'dev' +release = 'dev' + +exclude_patterns = ['**/.#*', '**/*~'] + + +def _get_description(fname, base): + with open(fname) as f: + one = None + while True: + line = f.readline().rstrip('\n') + if not line: + continue + if line.startswith(':') and line.endswith(':'): + continue + if line.startswith('.. '): + continue + one = line + break + two = f.readline().rstrip('\n') + three = f.readline().rstrip('\n') + assert one == three + assert all(c=='=' for c in one) + 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 + path = os.path.join(section_dir, filename) + description = _get_description(path, base) + 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' |