-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Made Commands.md dynamically generated #7346
Conversation
0840773
to
a519162
Compare
PS: I can rewrite the test properly if the |
Another option would be to make doc generation actually dynamic and move this script invocation to |
Added a test to enforce template usage: test checks if the |
Rebased to resolve conflicts |
Fully dynamic is better. Whenever something can be done so it works without manual labor, it should be done. |
@jpakkane , done. But please check if it works on your machine as well, since site generation (and upload) is not covered by any tests (AFAIK). |
This pull request introduces 2 alerts when merging 68cf874 into d6c6b93 - view on LGTM.com new alerts:
|
It currently fails because Testing it yourself is simple:
|
Strange, it works for me :\ |
Added a flag, renamed |
Replaced
docs/markdown/Commands.md
with dynamic generation from template:tools/regenerate_docs.py
:This script generates
docs/markdown/Commands.md
fromdocs/markdown_dynamic/Commands.md
, using the currentmeson.py
to get the relevant data. Template rendering is implemented viajinja2
Python package.tools/regenerate_docs.py
fromdocs/meson.build
(which is used to generate site docs during release).