On Wed, Apr 21, 2021 at 11:12 AM Conor Walsh <conor.wa...@intel.com> wrote: > > 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.
Note: We used literalinclude in the past and there was an issue with pdf: https://git.dpdk.org/dpdk/commit/?id=d3ce1dc637c1bbef9a407f10281b2bc0549256da But we don't generate pdf anymore, so we are good. > > Signed-off-by: Conor Walsh <conor.wa...@intel.com> Acked-by: David Marchand <david.march...@redhat.com> -- David Marchand
