Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automate collecting changes from gpac -genmd #7

Open
nlsdvl opened this issue Jun 7, 2024 · 4 comments
Open

automate collecting changes from gpac -genmd #7

nlsdvl opened this issue Jun 7, 2024 · 4 comments

Comments

@nlsdvl
Copy link
Collaborator

nlsdvl commented Jun 7, 2024

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

@jeanlf
Copy link
Member

jeanlf commented Jun 7, 2024

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
Copy link
Collaborator Author

nlsdvl commented Jun 19, 2024

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
Copy link
Member

jeanlf commented Jun 19, 2024

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 added a commit to gpac/gpac that referenced this issue Jul 4, 2024
jeanlf added a commit that referenced this issue Jul 4, 2024
@jeanlf
Copy link
Member

jeanlf commented Jul 4, 2024

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

@nlsdvl nlsdvl mentioned this issue Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants