Skip to content
  • Peter Hutterer's avatar
    dox: switch to sphinx for the user-visible documentation · cbd4f354
    Peter Hutterer authored
    
    
    This is a large commit because it's difficult to split this up and we don't
    care about bisecting here anyway.
    
    doxygen is going to produce the API documentation only
    sphinx is going to produce the prose user (and a bit of developer) documentation.
    
    The source split is doc/api and doc/user.
    
    Steps performed:
    - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst
    - manually fixed the .rst to render correctly
    - add a few extra .rst documents to generate the right hierarchy
    - hook up sphinx-build in meson
    - add a new @mainpage for doxygen more aimed at developers
    
    For the build directory:
    - sphinx produces /Documentation
    - doxygen now produces /api/
    
    These need to be manually combined in the wayland-web repo, meson doesn't
    support subdirectories as output paths within the build dir and the
    documentation doesn't need to be installed anywhere.
    
    Signed-off-by: default avatarPeter Hutterer <peter.hutterer@who-t.net>
    cbd4f354
This project is licensed under the Other. Learn more