AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-27 14:10:30 +00:00
Code Issues Projects Releases Wiki Activity

docs: Fix links in markdown content differently

Browse Source 
pandoc insists on using the xlink namespace for hrefs,
and the namespace setup doesn't carry over xi:includes.
My first fix was to tell pandoc to generate standalone
docbook documents, which makes it insert the xlink
namespace. But it also makes it wrap all sections and
chapters in articles, and that messes up our toc structure.

So, patch things up differently by stripping the xlink:
from hrefs via regex.

Yay for XML!
This commit is contained in:
Matthias Clasen 2020-07-29 07:45:02 -04:00
parent d40b1d31b5
commit 85fb015b45
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/gtk/gtk-markdown-to-docbook
View File

@ -12,6 +12,13 @@ import subprocess
# The following code is taken from gtk-doc # The following code is taken from gtk-doc
def ExpandAbbreviations(symbol, text): def ExpandAbbreviations(symbol, text):
# Hack!
# Strip xlink namespace from hrefs since pandoc insists on
# inserting them, and namespace setup doesn't transfer across
# xi:include.
# Yay for XML!
text = re.sub('xlink:href', 'href', text)
# Convert '@param()' # Convert '@param()'
text = re.sub(r'(\A|[^\\])\@(\w+((\.|->)\w+)*)\s*\(\)', r'\1<parameter>\2()</parameter>', text) text = re.sub(r'(\A|[^\\])\@(\w+((\.|->)\w+)*)\s*\(\)', r'\1<parameter>\2()</parameter>', text)
@ -177,7 +184,6 @@ def ConvertToDocbook(infile, outfile):
subprocess.check_call(["pandoc", infile, "-o", outfile, subprocess.check_call(["pandoc", infile, "-o", outfile,
"--from=" + input_format, "--from=" + input_format,
"--to=" + output_format, "--to=" + output_format,
"--standalone",
"--top-level-division=" + division]) "--top-level-division=" + division])
def ExpandGtkDocAbbreviations(infile, outfile): def ExpandGtkDocAbbreviations(infile, outfile):