2018-07-26 12:45:10 -04:00
|
|
|
.. _writingdocs:
|
|
|
|
|
|
|
|
|
|
#########################
|
|
|
|
|
Writing VPP Documentation
|
|
|
|
|
#########################
|
|
|
|
|
|
2018-08-02 15:03:15 -04:00
|
|
|
This section covers the following topics:
|
|
|
|
|
|
|
|
|
|
* Building VPP Documents
|
|
|
|
|
* Merging FD.io VPP documents and performing a Git review
|
|
|
|
|
* Using Read the Docs
|
|
|
|
|
* reStructured Text Style Guide that describes different format styles
|
|
|
|
|
* Markdown Style Guide that describes different format styles
|
|
|
|
|
|
|
|
|
|
|
2018-07-26 12:45:10 -04:00
|
|
|
.. toctree::
|
|
|
|
|
|
|
|
|
|
buildingrst
|
|
|
|
|
gitreview
|
|
|
|
|
readthedocs
|
|
|
|
|
styleguide/index.rst
|
|
|
|
|
styleguidemd/index.rst
|
|
|
|
|
todo
|
|
|
|
|
pushingapatch
|
