docs/gettingstarted/writingdocs/index.rst

   1 .. _writingdocs:
   2
   3 #########################
   4 Writing VPP Documentation
   5 #########################
   6
   7 This section covers the following topics:
   8
   9 * Building VPP Documents
  10 * Merging FD.io VPP documents and performing a Git review
  11 * Using Read the Docs
  12 * reStructured Text Style Guide that describes different format styles
  13 * Markdown Style Guide that describes different format styles
  14
  15
  16 .. toctree::
  17
  18   buildingrst
  19   gitreview
  20   readthedocs
  21   styleguide/index.rst
  22   styleguidemd/index.rst
  23   todo
  24   pushingapatch