Considering support restructuredText or even Sphinx?
Hello, I am glad that we have a gtk-doc replacemenet :D comes with GTK4, But I think if gi-docgen add restructuredText(reST) support, we can benefit from good infrastructure of it:
- reST have offical python implementation(docutils), gi-docgen is written by python too
- reST has native extension mechanism: interpreted text for inline element and directive for block element, we no need to add a linking syntax to markdown
- Sphinx is a powerful documentation generator with reST as the first-class markup language, Sphinx is widely used by almost all Python project, Linux Kernel 2.1 Sphinx already provides domain and autodoc mechanism for fetching and generating API reference 2.2 Sphinx supports various output format: html, html5, man, epub, latex, odt, xml, s5, we can save many time to deal with documnet format 2.4 Sphinx also can references across sphinx project, so we can reference GLib symbol in GTK documentation
- https://github.com/pygobject/pgi-docgen seems do such a thing and works well