automate collecting changes from gpac -genmd

[nlsdvl]

Part of the documentation comes from running the gpac -genmd documentation.
Currently this needs to be updated manually.

[jeanlf]

Also, adding new filters will require adding the .md to the git repo and patching the mkdocs tree, it would be nice if we could automate this part as well...

[nlsdvl]

Updating the navigation tree, do you mean to update the list of filters only ? How was that implemented on the github wiki ?

the following needs to be taking into account:

• the tree is configured manually in mkdocs.yml, only a portion of the tree is referencing auto generated content
• the navigation tree takes the file path, but also needs a display/name for the menu. For filters, the filter name is enough. The existing navigation tree items should preserve their current display/name.

Generating the mardown files by running genmd could be done with a github action on the gpac repo. Alternatively cron job could handle it on a daily basis.

[jeanlf]

Updating the navigation tree, do you mean to update the list of filters only ? How was that implemented on the github wiki ?

Yes only for the list of filters. The github wiki sidebar was generated along with the filter md files. This way we were sure to never miss a filter in the navigation bar.

[jeanlf]

current status:

1. gpac -genmd will now patch mkdocs.yml to inject all filters
2. ./scripts/genmd.sh will add all md and mkdocs.yml to git - this obviously needs some rework once integrated in an automated step

[jeanlf]

What's the status here ? Is there anything missing in gpac or can we now fully automate the wiki generation ?

[nlsdvl]

It's mostly a matter of deciding how/where the automation should be implemented. It could be in github workflow - eg. running in docker - or on the buildbot.

Basically, it is a matter of automating:

• using the fresh build of each commit on gpac's master branch
• checkout this repo and run genmd
• if there is a diff, commit and push it here