Skip to content

Commit

Permalink
docs: doc-guide: avoid using ReST :doc:foo markup
Browse files Browse the repository at this point in the history
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d6cbe5183406e3378ed4bd0f84f4bcf85a15009c.1623824363.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Jun 17, 2021
1 parent 6dce82b commit fd88d2e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/doc-guide/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,10 @@ We have been trying to improve the situation through the creation of
a set of "books" that group documentation for specific readers. These
include:

- :doc:`../admin-guide/index`
- :doc:`../core-api/index`
- :doc:`../driver-api/index`
- :doc:`../userspace-api/index`
- Documentation/admin-guide/index.rst
- Documentation/core-api/index.rst
- Documentation/driver-api/index.rst
- Documentation/userspace-api/index.rst

As well as this book on documentation itself.

Expand Down

0 comments on commit fd88d2e

Please sign in to comment.