diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-08-19 11:38:06 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:32 +0000 |
| commit | 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 (patch) | |
| tree | 3cca19635417e28ae381d67ae31c75df2925032d /doxygen/dev_doc.md | |
| parent | f47122e07e1ecd0151902a3cabe46c60a99bee8e (diff) | |
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>
Diffstat (limited to 'doxygen/dev_doc.md')
| -rw-r--r-- | doxygen/dev_doc.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/doxygen/dev_doc.md b/doxygen/dev_doc.md deleted file mode 100644 index 77a32acaa0f..00000000000 --- a/doxygen/dev_doc.md +++ /dev/null @@ -1,27 +0,0 @@ -Developer Documentation {#dev_doc} -======================= - -Programming notes for developers. - -- @subpage test_framework_doc -- @subpage sample_plugin_doc -- @subpage api_doc -- @subpage vapi_doc -- @subpage acl_hash_lookup -- @subpage acl_multicore -- @subpage acl_lookup_context -- @subpage libmemif_doc -- @subpage syslog_doc -- @subpage ipfix_doc -- @subpage stats_doc -- @subpage if_stats_client_doc -- @subpage api_lang_doc -- @subpage handoff_queue_demo_plugin -- @subpage lcov_code_coverage -- @subpage mdata_doc -- @subpage mempreload_doc -- @subpage pnat_doc -- @subpage snap_doc -- @subpage srv6_ad_flow_plugin_doc -- @subpage strongswan_test_doc -- @subpage srtp_doc |