doc: show how to include code in guides
authorConor Walsh <conor.walsh@intel.com>
Thu, 6 May 2021 16:40:59 +0000 (16:40 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 19 May 2021 21:36:02 +0000 (23:36 +0200)
commit413c75c33c402a3170b8311bdc9afb7bded29207
treeabae1b19d49e4d6df1774036764aaa714707441a
parent0d025f019c68e80d0e2f09764465dcd0afdd7cd9
doc: show how to include code in guides

Currently the documentation describes how to add code snippets to the
docs using code blocks. This can be problematic as the code snippets
in the docs may fall out of sync with the actual code it is referencing
within DPDK. This patch adds instructions to the contribution guide
about how to include code in the docs using literalinclude which will
dynamically get the code from source when the docs are generated. This
will help to ensure that the code within the docs is up to date and not
out of sync with the actual code.

Signed-off-by: Conor Walsh <conor.walsh@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
doc/guides/contributing/documentation.rst