Skip to content
  • Nathan Skrzypczak's avatar
    docs: better docs, mv doxygen to sphinx · 9ad39c02
    Nathan Skrzypczak authored
    
    
    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: default avatarNathan Skrzypczak <nathan.skrzypczak@gmail.com>
    Signed-off-by: default avatarAndrew Yourtchenko <ayourtch@gmail.com>
    9ad39c02
Loading