| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 1 | .. _writingdocs: |
| 2 | |
| 3 | ######################### |
| 4 | Writing VPP Documentation |
| 5 | ######################### |
| 6 | |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 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 | |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 16 | .. toctree:: |
| andrew | df50b45 | 2018-08-09 13:23:59 -0400 | [diff] [blame] | 17 | :maxdepth: 2 |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 18 | |
| andrew | df50b45 | 2018-08-09 13:23:59 -0400 | [diff] [blame] | 19 | buildingrst |
| 20 | gitreview |
| 21 | readthedocs |
| 22 | styleguide/index.rst |
| 23 | styleguidemd/index.rst |
| 24 | todo |
| 25 | pushingapatch |