[Feature] - Merge reference.json and extension_map.json, plus documentation generator fixes #6268
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.
Why?
python website/generate_platform_v4_markdown.py
only checks if the extensions are installed, but to generate the full documentation we need them to be installed and built intoreference.json
openbb.build()
is split betweenreference.json
andextension_map.json
openbb-core
version was used to generate the static assetsobb.coverage.reference
can equivalent to openapi.json so it makes more sense to access it from the rootWhat?
extension_map.json
intoreferece.json
and follow a OpenAPI like format, see screenshot belowgenerate_platform_v4_markdown.py
script to this changereference
withobb.reference
SystemSettings
Impact
reference.json
(it also fails if version is unexpected)obb.reference
and get the commands fromreference.json
paths property?Testing Done:
reference.json
extension versions to be incompatible with toml specpython website/generate_platform_v4_markdown.py
in several scenarios with and without built extensions