[dpdk-dev] [PATCH 0/3] doc: added guidelines on dpdk documentation
John McNamara
john.mcnamara at intel.com
Thu Jul 2 15:50:50 CEST 2015
This patchset:
* Adds guidelines on the purpose and structure of the DPDK documentation,
how to build it and guidelines for creating it and adding to it.
* Also adds guidelines on how to format and submit a documentation patch.
* Moves and refactores the Doxygen guidelines from the Coding Style doc to
the Documentation Guidelines doc.
As with the other guidelines the main idea is to document the status quo and
then modify/add to it over time.
John McNamara (3):
doc: set the default literal block format
doc: added guidelines on dpdk documentation
doc: moved doxygen section to the doc guidelines
doc/guides/conf.py | 1 +
doc/guides/guidelines/coding_style.rst | 126 +---
doc/guides/guidelines/documentation.rst | 1005 +++++++++++++++++++++++++++++++
doc/guides/guidelines/index.rst | 2 +
4 files changed, 1015 insertions(+), 119 deletions(-)
create mode 100644 doc/guides/guidelines/documentation.rst
--
1.8.1.4
More information about the dev
mailing list