Conflict between gi-docgen and g-ir-doc-tool
@nielsdg In commit 92e80d12, you made this change:
- * <Prefix>/Path/To/Submenu
- *
- * for instance:
- *
- * <Image>/Layer/Transform
+ * syntax `<Prefix>/Path/To/Submenu`, for example `<Image>/Layer/Transform`
Except that it breaks g-ir-doc-tool
/yelp-build
which is apparently seeing these as XML tags (or so I guess it's XML or another similar syntax):
[29/31] Generating g-ir-Gimp-python-html with a custom command
FAILED: devel-docs/g-ir-docs/Gimp-python-html
/usr/bin/yelp-build html -o devel-docs/g-ir-docs/html/python/Gimp-3.0 devel-docs/g-ir-docs/pages/python/Gimp-3.0
file:///home/jehan/.local/share/crossroad/artifacts/native/gimp/gimp/devel-docs/g-ir-docs/pages/python/Gimp-3.0/Gimp.Procedure.add_menu_path.page:34: parser error : Opening and ending tag mismatch: Image line 34 and p
syntax `<Prefix>/Path/To/Submenu`, for example `<Image>/Layer/Transform`</p> <p
^
file:///home/jehan/.local/share/crossroad/artifacts/native/gimp/gimp/devel-docs/g-ir-docs/pages/python/Gimp-3.0/Gimp.Procedure.add_menu_path.page:47: parser error : Opening and ending tag mismatch: Prefix line 34 and page
</page>
^
file:///home/jehan/.local/share/crossroad/artifacts/native/gimp/gimp/devel-docs/g-ir-docs/pages/python/Gimp-3.0/Gimp.Procedure.add_menu_path.page:48: parser error : Premature end of data in tag p line 33
^
Traceback (most recent call last):
File "/usr/bin/yelp-build", line 830, in <module>
sys.exit(YelpBuild().main())
File "/usr/bin/yelp-build", line 813, in main
return builder.main(sys.argv[2:])
File "/usr/bin/yelp-build", line 690, in main
return self.xhtmlbuilder.main(args)
File "/usr/bin/yelp-build", line 596, in main
tree = self.get_xml(infile, path)
File "/usr/bin/yelp-build", line 285, in get_xml
tree = lxml.etree.parse(infile.absfile, parser=parser)
File "src/lxml/etree.pyx", line 3521, in lxml.etree.parse
File "src/lxml/parser.pxi", line 1859, in lxml.etree._parseDocument
File "src/lxml/parser.pxi", line 1885, in lxml.etree._parseDocumentFromURL
File "src/lxml/parser.pxi", line 1789, in lxml.etree._parseDocFromFile
File "src/lxml/parser.pxi", line 1177, in lxml.etree._BaseParser._parseDocFromFile
File "src/lxml/parser.pxi", line 615, in lxml.etree._ParserContext._handleParseResultDoc
File "src/lxml/parser.pxi", line 725, in lxml.etree._handleParseResult
File "src/lxml/parser.pxi", line 654, in lxml.etree._raiseParseError
File "devel-docs/g-ir-docs/pages/python/Gimp-3.0/Gimp.Procedure.add_menu_path.page", line 34
lxml.etree.XMLSyntaxError: Opening and ending tag mismatch: Image line 34 and p, line 34, column 77
We need a way to write <>
for both formats or find some other solution.
Unless we decide that the main doc is enough and that we don't need binding-dedicated docs (though did like the idea to have binding docs as well).
Anyway right now it's bad because the build fails with -Dg-ir-doc=true
(which also makes me think we should have enabled this in our CI to see this issue earlier at MR time; I will do so after we can fix this bug).