aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen/siphon
AgeCommit message (Collapse)AuthorFilesLines
2020-04-06misc: fix python sonarcloud BLOCKER level issuesPaul Vinciguerra1-0/+1
Fix of the top 11 python issues flagged as BLOCKER. Ticket: VPP-1856 Type: fix Change-Id: Icf4691e62f4a69d6ee196b6d6e2ab52d961b5c76 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-10docs: doxygen fix siphon under python3Paul Vinciguerra1-3/+4
siphon used cgi.escape which was deprecated in python 3.2 and removed in python 3.8. Update the code to use html.escape instead. Type: fix Change-Id: I3192e3f69a4a95fe23cb24e1c29194ba5310932b Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-05docs: fix 'make doxygen' under python3Paul Vinciguerra7-36/+49
The 'make doxygen' component has this cool vpp specific customization called siphon. This updates the siphon component so that 'make doxygen' works with python3. Needed-By: https://gerrit.fd.io/r/23159 Type: docs Change-Id: Ie29f1602bf3460b637058acbb0a2f19b128a8824 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2016-11-28Add support for using documentation siphons in multiple waysChris Luke1-20/+59
Experiental support for generating multiple output formats from the same siphoned data. Adds a contrived example to generate a plain list of all CLI commands (the "itemlist" format). Eventually we can consider moving the tempate procesisng into the Output class as well as a way to override how the data is traversed (ordered). Change-Id: I77629a74a8fa0c7e583993469dc50491f72f13e7 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-27Fix missing output in generated CLI/configChris Luke1-0/+1
The templates were looking for the name of the CLI_COMMAND and CONFIG_FUNCTION structures in the srong place. Change-Id: I709d6716216173ba6a7ed41a260728238f96d2db Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-21Refactor pre-Doxy siphon scripts; VPP-396Chris Luke8-0/+878
- Modularize the code to make the Siphon process easier to maintain. - Move much of the output rendering into Jinja2 templates. - Add syscfg siphon type for startup config documentation. - Add sample syscfg documentation. - Add clicfg and syscfg preamble docs, adapted from their wiki pages. - Fix sorting of CLI items across multiple directories. Change-Id: Ib8288fe005adfea68ceed75a38ff8eba25d3cc79 Signed-off-by: Chris Luke <chrisy@flirble.org>