openSUSE / agama / 7448776321

75%

master: 72%

push

github

[web][doc] Use external-module-map and merge-modules typedoc plugins

For a future integration with static site generators like Docusaurus or
Vitepress, this commit applies the necessary typedoc configuration and
plugins for a more reasonable output structure. Of course, it can (when
not must) be improved, but it's a good starting point for testing.

In short, this commit

  * Adjusts some typedoc options like sort, navigation, and others.
  * Uses the typedoc-plugin-external-module-map in ordert to avoid
    adding the "@module Whatever" at the beginning of each file
    manually.
  * Uses typedoc-plugin-merge-modules to group docs of the same module
    and category. Since it renames the default exports it makes
    typedoc-plugin-rename-defaults obsolete.
  * Separates client and component documentation processing tasks since
    their organizational structure differs slightly.
  * Creates a new task for running these two.

Despite not been included in this commit, typedoc-plugin-markdwon will
be needed for mentioned integration.

To know more,

  * https://typedoc.org/options/organization/
  * https://github.com/asgerjensen/typedoc-plugin-external-module-map
  * https://github.com/krisztianb/typedoc-plugin-merge-modules
  * https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown
  * https://docusaurus.io/
  * https://vitepress.dev/

1426 of 2171 branches covered (0.0%)

Branch coverage included in aggregate %.

16064 of 21150 relevant lines covered (75.95%)

22.61 hits per line