6 Commits

Author SHA1 Message Date
Paul Vinciguerra
582eac5c30 misc: fix python sonarcloud BLOCKER level issues
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-04-06 11:30:05 +00:00
Paul Vinciguerra
b55aec1c8e docs: doxygen fix siphon under python3
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>
2020-03-10 17:09:57 +00:00
Paul Vinciguerra
464e5e0bfe docs: fix 'make doxygen' under python3
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>
2019-11-05 21:08:27 +00:00
Chris Luke
c3f92adf6b Add support for using documentation siphons in multiple ways
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-11-28 18:23:35 +00:00
Chris Luke
af405f77c7 Fix missing output in generated CLI/config
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-27 18:15:58 +00:00
Chris Luke
90f52bf990 Refactor pre-Doxy siphon scripts; VPP-396
- 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>
2016-09-21 15:42:25 -04:00