aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2023-08-16tests docs: update python3 venv packagesDave Wallace1-1/+1
- Package update performed by 1. updating pip, pip-tools, setuptools 2. 'make test-refresh-deps' on ubuntu 22.04 3. fixing 'make test' and 'make docs' issues on ubuntu 22.04 4. 'make test-refresh-deps' on ubuntu 20.04 - Add dependency for 'make test-refresh-deps' to insure python venv is set up. - Update of python formatter, black, caused reformating of 41 python code files. Type: make Change-Id: I7cafdf4b5189065ac57cb6b254937f6e0897a924 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2022-05-10tests: replace pycodestyle with blackKlement Sekera1-37/+50
Drop pycodestyle for code style checking in favor of black. Black is much faster, stable PEP8 compliant code style checker offering also automatic formatting. It aims to be very stable and produce smallest diffs. It's used by many small and big projects. Running checkstyle with black takes a few seconds with a terse output. Thus, test-checkstyle-diff is no longer necessary. Expand scope of checkstyle to all python files in the repo, replacing test-checkstyle with checkstyle-python. Also, fixstyle-python is now available for automatic style formatting. Note: python virtualenv has been consolidated in test/Makefile, test/requirements*.txt which will eventually be moved to a central location. This is required to simply the automated generation of docker executor images in the CI. Type: improvement Change-Id: I022a326603485f58585e879ac0f697fceefbc9c8 Signed-off-by: Klement Sekera <klement.sekera@gmail.com> Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2022-03-28libmemif: refactor examplesJakub Grajciar1-1/+1
- icmp_responder: responds to ICMPv4 and ARP requests - loopback: connects two interfaces and sends a verification packet from master memif to slave memif where it is looped back - loopback (reverse path): reverses direction of packet in loopback application (slave memif to master memif) Type: refactor Signed-off-by: Jakub Grajciar <jgrajcia@cisco.com> Change-Id: Ie90aaa3367269408efb6c5d538ad5aa827432238 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2021-11-16docs: consume fd.io version listNathan Skrzypczak1-6/+2
Type: feature This adds a version snippet in the vpp docs, based on a json description fetched from fd.io/vpp_versions.json This relies on https://github.com/FDio/site/pull/108 being merged Change-Id: I6dd22f09927841aef96011ed57af2cbdc5d409f5 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak1-3/+9
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-3/+3
- 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-04-02docs: Fix venv under python3Paul Vinciguerra1-4/+2
See ticket for output under containers for each distro. Ticket: VPP-1851 Type: docs Change-Id: I0d80dabeb30d92d09edffa503b05d5eef08313dc Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-23docs: add container functional test writeupDave Barach1-1/+1
Fix global copyright date Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I7f010d63ec010982f2c8c8388f14214fa6ced0a7
2020-01-24docs: Update the requirements and fix the buildJohn DeNisco1-2/+4
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: I30e37f7e549083337b11ace95b4ff4f427d9fc8c
2019-11-06docs: Rewrite the what is VPP (first) section, also fix the buildJohn DeNisco1-2/+2
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: Ifb558171f8976a721703e74afea997d006273b5f Signed-off-by: Dave Barach <dave@barachs.net>
2019-11-06docs: add spellcheck to 'make docs' sphinx docsPaul Vinciguerra1-5/+10
The CI gate will fail if there are typos in the docs. writing output... [ 21%] events/Summits/OpensourceSummit... writing output... [ 22%] events/Summits/UKNO/2017_04_30_... featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06 writing output... [100%] usecases/vppinazure Spelling checker messages written to /vpp/docs/_build/html/output.txt Warning, treated as error: Found 1 misspelled words Makefile:31: recipe for target 'html' failed make[1]: *** [html] Error 2 make[1]: Leaving directory '/vpp/docs' If you introduce a term that is not recognized, please add it to custom dictionary at docs/spelling_wordlist.txt. Type: feature Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-09-11docs: run-sphinx-docs-mergedjdenisco1-1/+1
Type: docs Signed-off-by: jdenisco <jdenisco@cisco.com> Change-Id: I571222f3e3672253930700e23cca4812dde84a6d
2019-07-19docs: Fix conf.py for read the docsjdenisco1-1/+0
Change-Id: Iaaf9e6ef5acc82fb751c851cc943cf0c48a8940d Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-17docs: Fix Versions and Titlesjdenisco1-2/+2
Change-Id: I131e33a570bff8b22c767585d03e2eb281dd7184 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16docs: Update sphinx, requirements, support markdown tablesjdenisco1-4/+7
Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-14DOCS: Moved multiarch and build system, Incorprated Scott's changesJohn DeNisco1-2/+2
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26Initial commit of Sphinx docsJohn DeNisco1-0/+178
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>