Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.29 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.29 KB

FFmpeg/Libav Docset Generator

This script creates a API docset for FFmpeg/Libav from its documentation. The docset can be used in the incredibly useful Dash. It is submitted also as a User Contributed docset for Dash.

Install

Requires doxygen, texi2html, Python 3.6.x

Install requirements on Ubuntu:

sudo apt-get install texi2html doxygen libsdl1.2-dev libsdl2-dev

Build FFmpeg Docset

./docset.py build which version

which is the api you want to build only ffmpeg and libav are valid option. version is the target ffmpeg/libav version. For example:

  • ./docset.py build ffmpeg 3.0.3 to build ffmpeg 3.0.3 api document
  • ./docset.py build libav 10.7 to build libav 10.7 api document

This will downloads the ffmpeg source tarball, generates the ffmpeg documentation, creates the docset and indexes all documentation files.

NOTE: Building the api document on a case-insensitive filesystem is useless, because both ffmpeg and libav have multiple same symbols with different cases, so on a case-insensitive filesystem you will only get the last generated document for those symbols.

Credits

Thanks for Klaus Badelt for the original idea.