docs: generate api documentation with jsdoc

jboix commented 6 months ago

Description

Resolves https://github.com/SRGSSR/pillarbox-web/issues/186 by introducing API documentation generation process:

Added jsdoc generation using the jsdoc-clean-theme.
Customized the theme with a header containing essential links, the Pillarbox logo, a homepage, and additional styling.
Focused API documentation generation only on the exported components: src/pillarbox, src/components/player, and src/middleware/srgssr
Moved the Known Issues article to the Tutorial section of the jsdoc for better organization.
Relocated the Default Options article to the Tutorial section of the jsdoc from its previous location in the wiki.

The documentation is generated alongside the demo page and deployed under /api.

Changes made

Updated class extension for the player and enhanced documentation by adding missing @class annotations and included additional typedefs in typedef.js file. The added typedefs improve TypeScript type generation for various video.js components, such as AudioTrack, TextTrack, and VideoJsPlayer. These changes aim to enhance code documentation and improve type support for TypeScript.

github-actions[bot] commented 6 months ago

Coverage report

St.^{:grey_question:}	Category	Percentage	Covered / Total
🟢	Statements	98.39% (-0% 🔻)	489/497
🟢	Branches	93.44%	228/244
🟢	Functions	100%	136/136
🟢	Lines	99.16% (-0% 🔻)	473/477

Test suite run success

153 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from c48b0eca0fcb30650e94a0ce21ee77fb411cb2a6

github-actions[bot] commented 6 months ago

:tada: This PR is included in version 1.0.0 :tada:

The release is available on:

npm package (@main dist-tag)
GitHub release

Your semantic-release bot :package::rocket:

SRGSSR / pillarbox-web