Improved docs from XML generation_toolchain #2103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hamishwillee
force-pushed
the
improved_docs_generation_toolchain
branch
2 times, most recently
from
587f58a
to
0be4689
Compare
hamishwillee
force-pushed
the
improved_docs_generation_toolchain
branch
from
412d0a6
to
77fda2a
Compare
- Make replaced-by a link - Fix message field desc - Make enums in param values into links - Fixes following testing - Add deprecated desc, if exists - Add todo if we ever get WIP tags with text in them - Make the main lists to dicts, to allow easier merging - Merge XMLs - Fix up ordering of items - Make more robust - can spot new fields - Improve table layout - Add max, min, invalid, instance, default, to fields - Add highlighting for WIP/Deprecated - Minor fix to intros - Add placeholder for building dialect tree - Add summary of stuff in THIS file - Flake8 Lint - Workflow to deploy docs + dependencies file
hamishwillee
force-pushed
the
improved_docs_generation_toolchain
branch
from
dc19845
to
757df34
Compare
|
Self merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The current docs generation toolchain uses XSL conversion of the XML to HTML, followed by some massaging of the produced HTML to produce some final output.
This is very clever and all, but inherently limited for generating docs, because:
So what this does is copy the ideas behind mavgen parser (but using beautifulsoup) to parse the XML into Python, and then generate markdown output.
This replaces the top level files.
Includes workflow to build the files, and start of workflow to deploy files. However no point finishing that until the old version is disabled, which depends on CI that relies on Daniel Agar. Waiting