[dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation
John McNamara
john.mcnamara at intel.com
Fri Jul 10 17:45:18 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.
* Moves and refactors 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.
V2:
* Incorporates mailing list comments.
* Removed doc patch contribution guide. Will submit separately
as contribution guidelines.
V1:
* Initial version.
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 | 134 +-----
doc/guides/guidelines/documentation.rst | 745 ++++++++++++++++++++++++++++++++
doc/guides/guidelines/index.rst | 2 +
4 files changed, 754 insertions(+), 128 deletions(-)
create mode 100644 doc/guides/guidelines/documentation.rst
--
1.8.1.4
More information about the dev
mailing list