On Fri, 2017-12-29 at 18:01 +0300, Ilya Maximets wrote: > Hard links to .rst files are broken in compiled documentation. > Fix that by changing to proper :doc: reference. > > Signed-off-by: Ilya Maximets <[email protected]>
I hadn't done this because MAINTAINERS is a top-level document and therefore likely to be viewed on GitHub. The 'doc' role won't render here and GitHub uses the docutils-based 'rst2html' tool to render text rather than Sphinx, and the 'doc' role is a Sphinx one. As such, I don't think you should do this. What I would do instead is move everything but the list of maintainers to whatever document is including this file. You can keep a small note in MAINTAINERS (possibly a reference to the other file) but this should be ignored in the other file by way of 'start-line' option for the 'include' directive. Stephen > --- > MAINTAINERS.rst | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst > index fec215a..587a578 100644 > --- a/MAINTAINERS.rst > +++ b/MAINTAINERS.rst > @@ -28,11 +28,11 @@ Committers > Open vSwitch committers are the people who have been granted access > to push > changes to to the Open vSwitch git repository. > > -The responsibilities of an Open vSwitch committer are documented > -`here <Documentation/internals/committer-responsibilities.rst>`__. > +The responsibilities of an Open vSwitch committer are documented in > +:doc:`/internals/committer-responsibilities`. > > -The process for adding or removing committers is documented > -`here <Documentation/internals/committer-grant-revocation.rst>`__. > +The process for adding or removing committers is documented in > +:doc:`/internals/committer-grant-revocation`. > > This is the current list of active Open vSwitch committers: > > @@ -77,8 +77,8 @@ This is the current list of active Open vSwitch > committers: > - [email protected] > > The project also maintains a list of Emeritus Committers (or > Maintainers). > -More information about Emeritus Committers can be found > -`here <Documentation/internals/committer-emeritus-status.rst>`__. > +More information about Emeritus Committers can be found in > +:doc:`/internals/committer-emeritus-status`. > > .. list-table:: OVS Emeritus Maintainers > :header-rows: 1 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
