diff options
| author | Ilya Maximets <i.maximets@ovn.org> | 2023-01-05 20:42:43 +0100 |
|---|---|---|
| committer | Ilya Maximets <i.maximets@ovn.org> | 2023-01-06 16:07:58 +0100 |
| commit | a7826d05b8ce8af2fc4042261edd2b0a196d7582 (patch) | |
| tree | 6db6618e9a4433576afafd721cc3208f9dec9d3c /Documentation | |
| parent | 1584062b9921c3f17d0f0129d49060cad1fdf8bd (diff) | |
| download | openvswitch-a7826d05b8ce8af2fc4042261edd2b0a196d7582.tar.gz | |
Documentation: Fix links in maintainers.rst.
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 <ivzhukov@sbercloud.ru>
Acked-by: Han Zhou <hzhou@ovn.org>
Acked-by: Eelco Chaudron <echaudro@redhat.com>
Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/internals/maintainers.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/internals/maintainers.rst b/Documentation/internals/maintainers.rst index 172d684df..0203bbe95 100644 --- a/Documentation/internals/maintainers.rst +++ b/Documentation/internals/maintainers.rst @@ -22,3 +22,8 @@ Avoid deeper levels because they do not render well. .. include:: ../../MAINTAINERS.rst + :end-before: Cut here for the Documentation/internals/maintainers.rst + +.. |responsibilities| replace:: :doc:`committer-responsibilities` +.. |grant-revocation| replace:: :doc:`committer-grant-revocation` +.. |emeritus-status| replace:: :doc:`committer-emeritus-status` |