On 1/6/23 10:51, Eelco Chaudron wrote: > > > On 5 Jan 2023, at 20:42, Ilya Maximets wrote: > >> GitHub and Sphinx are parsing links differently. Sphinx knows about >> the overall documentation structure and all the sections defined in >> other docs, while GitHub is using direct rst 2 html conversion and >> doesn't know any of that. Sphinx wants links to sections in other >> docs to be defined with a :doc: field, but GitHub can't parse that >> and requires having a direct link to the other rST document. >> >> The problem is that we have a top level MAINTAINERS.rst, that should >> be parseable by GitHub, included in the maintainers.rst in the >> main documentation section that is used by Sphinx to generate html, >> pdf and other docs. So, it's hard to make links work in both. >> >> Working around that limitation by using rST substitutions for the >> links. Cutting off the substitutions for actual links and adding >> :doc: links instead during the file inclusion for Sphinx. >> >> Reported-by: Igor Zhukov <[email protected]> >> Signed-off-by: Ilya Maximets <[email protected]> > > The changes look good to me. > > Acked-by: Eelco Chaudron <[email protected]> >
Thanks, Han and Eelco! Applied and backported down to 2.13 just in case. Best regards, Ilya Maximets. _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
