RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-18 18:42:46 +02:00
Code Issues Projects Releases Wiki Activity

[docs] Add support for Markdown documentation when creating man pages

Browse Source 
rL358749 added a documentation page in the Markdown format. Currently,
such pages are ignored in the configuration script for manual pages.
This patch fixes that.

Differential Revision: https://reviews.llvm.org/D60964

llvm-svn: 359860
This commit is contained in:
Igor Kudrin 2019-05-03 05:11:48 +00:00
parent cf8d0ecc05
commit 17113999e5
1 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/conf.py
View File

@ -11,7 +11,7 @@
# serve to show the default.
from __future__ import print_function
import sys, os
import sys, os, re
from datetime import date
# If extensions (or modules to document with autodoc) are in another directory,
@ -223,32 +223,50 @@ basedir = os.path.dirname(__file__)
man_page_authors = "Maintained by the LLVM Team (https://llvm.org/)."
command_guide_subpath = 'CommandGuide'
command_guide_path = os.path.join(basedir, command_guide_subpath)
for name in os.listdir(command_guide_path):
# Ignore non-ReST files and the index page.
if not name.endswith('.rst') or name in ('index.rst',):
continue
# Otherwise, automatically extract the description.
def process_md(name):
file_subpath = os.path.join(command_guide_subpath, name)
with open(os.path.join(command_guide_path, name)) as f:
title = f.readline().rstrip('\n')
m = re.match(r'^# (\S+) - (.+)$', title)
if m is None:
print("error: invalid title in %r "
"(expected '# <name> - <description>')" % file_subpath,
file=sys.stderr)
else:
man_pages.append((file_subpath.replace('.md',''), m.group(1),
m.group(2), man_page_authors, 1))
def process_rst(name):
file_subpath = os.path.join(command_guide_subpath, name)
with open(os.path.join(command_guide_path, name)) as f:
title = f.readline().rstrip('\n')
header = f.readline().rstrip('\n')
if len(header) != len(title):
print((
"error: invalid header in %r (does not match title)" % (
file_subpath,)), file=sys.stderr)
print('error: invalid header in %r (does not match title)' %
file_subpath, file=sys.stderr)
if ' - ' not in title:
print((
("error: invalid title in %r "
"(expected '<name> - <description>')") % (
file_subpath,)), file=sys.stderr)
print("error: invalid title in %r "
"(expected '<name> - <description>')" % file_subpath,
file=sys.stderr)
# Split the name out of the title.
name,description = title.split(' - ', 1)
man_pages.append((file_subpath.replace('.rst',''), name,
description, man_page_authors, 1))
for name in os.listdir(command_guide_path):
# Process Markdown files
if name.endswith('.md'):
process_md(name)
# Process ReST files apart from the index page.
elif name.endswith('.rst') and name != 'index.rst':
process_rst(name)
# If true, show URL addresses after external links.
#man_show_urls = False