aboutsummaryrefslogtreecommitdiffstats
path: root/test/doc/overview.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak1-450/+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>
2021-08-13tests docs: upgrade python packagesDave Wallace1-31/+36
- Upgrade python package requirements for test & docs - Clean up docs generation warnings - Consolidate python requirements for docs in test requirements specs. - Upgrade pip Type: make Change-Id: I74a3924b43ed93d15b32ec9f6fc41ed1ba95b69b Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2020-12-03tests: fix typo in numbered list in documentationElias Rudberg1-5/+6
Fix a typo in numbered list in the documentation. Also mention possibility of using TEST= to run a specific test. Type: fix Signed-off-by: Elias Rudberg <elias.rudberg@bahnhof.net> Change-Id: I026703af014493afb3dea2d9ad99a7bb510b135d
2019-03-07Tests: Refactor payload_to_info()Paul Vinciguerra1-1/+1
All callers of payload_to_info were required to wrap payload with str(). Refactor to call scapy's payload.load for raw payloads or specify the specific fieldname. Change-Id: I1c80599d4df8dc129dbb8274733afaad406d5bcf Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2018-10-12Add parallel test run info to test/docjuraj.linkes1-1/+27
An overview of parallel test runs, describing the library used, results gathering, stdout and stderr handling and how to execute a parallel run. Change-Id: Ic83cd689751ee46914e3b858b0b24a74b083f99f Signed-off-by: juraj.linkes <juraj.linkes@pantheon.tech>
2017-01-27make-test: Add numbering to chapters' titlesTibor1-1/+1
Change-Id: I1e2aedba85caf903dd7a721841afe240a9791cac Signed-off-by: Tibor <tifrank@cisco.com>
2017-01-27make test: improve documentation generationKlement Sekera1-0/+418
Refactor the text to work around sphinx bug to show a proper table of contents. Change-Id: I546656ef77a95637ad7c6bf239f26262a4f306dc Signed-off-by: Klement Sekera <ksekera@cisco.com>