docs: Add first version of a script that can convert forms from core into tabbed restructured text pages #697
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I did quite a few of these so lets automate it.
The result can be seen in this PR:
#696
The script is executed like this inside the docs folder:
/bin/python3.11 ./collect_forms.py --input /src/git/core/src/opnsense/mvc/app/controllers/OPNsense/Firewall/forms
And it will generate the following output:
This can be used as includes in a manual like this:
.. include:: /manual/forms/Firewall/dialogfilterrule.rst
Now we can regenerate this tabbed view we have used in the manual without manually editing it. Its just one script execution and thats it.