ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
vpp/docs/docsignore

9 lines
357 B
Plaintext
Raw Normal View History

docs: better docs, mv doxygen to sphinx 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-19 11:38:06 +02:00
# This is a list of ignored documentation files
# in VPP. Not linking these files in ./docs won't
# trigger an error in ./extra/scripts/check_documentation.sh
extras/deprecated/dpdk-hqos/qos_doc.md
extras/deprecated/dpdk-ipsec/dpdk_crypto_ipsec_doc.md
src/vpp-api/lua/README.md
src/vpp-api/lua/examples/cli/README.md
src/vpp-api/lua/examples/lute/README.md
Reference in New Issue Copy Permalink