automate collecting changes from gpac -genmd

gpac / wiki

GPAC's wiki, the entrypoint to MP4Box and GPAC documentation.

https://wiki.gpac.io

GNU Lesser General Public License v2.1

0 stars 3 forks source link

automate collecting changes from gpac -genmd #7

Open nlsdvl opened 3 months ago

nlsdvl commented 3 months ago

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

jeanlf commented 3 months ago

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 commented 2 months ago

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 commented 2 months ago

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 commented 2 months ago

current status:

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