Writing Documents

This section covers the following topics:

• Building VPP Documents

• Merging FD.io VPP documents and performing a Git review

• reStructured Text Style Guide that describes different format styles

• Markdown Style Guide that describes different format styles

• Creating VPP Documents
  • Get the VPP sources
  • Install the Necessary Packages
  • Create a Virtual Environment using virtualenv
  • Build the html files
  • Clean the environment
  • View the results
  • Getting your documents reviewed and merged
• reStructured Text Style Guide
  • Heading 1
    • Heading 2
  • Bullets, Bold and Italics
  • Notes
  • Code Blocks
  • Tables
    • Grid Tables
    • Simple Tables
  • Labels, References
  • External Links
  • Images
  • Including a file
    • An XML File
  • Raw HTML
    • Raw HTML Example
• Markdown Style Guide
  • Heading 1
    • Heading 2
  • Bullets, Bold and Italics
  • Code Blocks
  • Labels, References
  • External Links
  • Images
  • Tables