summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/buildingrst.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak1-94/+0
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
2019-05-28docs: Add some packages for building the docsjdenisco1-0/+11
Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-24Add the sphinx docs build optionsjdenisco1-8/+12
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-13DOCS: Cleanup Getting StartedJohn DeNisco1-178/+21
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-09DOCS: modified writing docs sectionjavierfernandezvalles1-1/+1
Change-Id: Ic3ec16dba1a6374785f25f622b2cdc9b6415a13b Signed-off-by: javierfernandezvalles <JaviervallesF@gmail.com>
2018-07-26Initial commit of Sphinx docsJohn DeNisco1-0/+236
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>