aboutsummaryrefslogtreecommitdiffstats
path: root/docs/reference/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak1-13/+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-02-19VPP-1504: Remove JVPPMichal Cmarada1-1/+0
As part of JVPP migration this removes JVPP completely from VPP. Change-Id: I6b74e7961aa474ae471e63fe43a624cd9fc3659b Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
2018-10-24docs: add useful debug CLIScott Keeler1-1/+1
Change-Id: I5ef9ecd741f1623ae1b7a23fa0a4fa6db7e243a3 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-08-17docs: Moved installing up a level, removed guides.John DeNisco1-0/+1
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Moved multiarch and build system, Incorprated Scott's changesJohn DeNisco1-3/+1
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-13DOCS: Cleanup Getting StartedJohn DeNisco1-2/+5
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-10DOC-ONLY: document latest multi-arch support schemeDave Barach1-0/+1
Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I613415c109f648248ee04dd76d5e652dbf21bc7f
2018-08-10DOC-ONLY: build system detailsDave Barach1-0/+1
The tables need some TLC from someone familiar with making pretty tables. Fixed text-wrapping onto newlines for all tables in our docs. Changed Environment Variables to ENV Variables so that the specific column header fits properly. Change-Id: Ie758612e561eefe44e771dac63b63bf026a52c2d Signed-off-by: Dave Barach <dave@barachs.net>
2018-07-26Initial commit of Sphinx docsJohn DeNisco1-0/+10
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>