Skip to content

Update Platform Architecture Overview & Markdown Generator #59

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

Merged
merged 22 commits into from
Apr 7, 2025

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Feb 25, 2025

^^^

This PR includes updates to accompany: OpenBB-finance/OpenBB#7069

@deeleeramone deeleeramone added the documentation Improvements or additions to documentation label Feb 25, 2025
@deeleeramone deeleeramone requested a review from piiq March 10, 2025 20:02
@piiq
Copy link
Collaborator

piiq commented Mar 11, 2025

I guess the fact that we don't require an OBBject anymore broke the API Reference generator

Traceback (most recent call last):
  File "/home/runner/work/openbb-docs/openbb-docs/scripts/generate_platform_markdown.py", line 696, in <module>
    generate_platform_markdown(obb.reference.get("paths", {}))
  File "/home/runner/work/openbb-docs/openbb-docs/scripts/generate_platform_markdown.py", line 637, in generate_platform_markdown
    path_data["returns"]["OBBject"]
KeyError: 'OBBject'

@deeleeramone deeleeramone changed the title Update Platform Architecture Overview Update Platform Architecture Overview & Markdown Generator Mar 21, 2025
@deeleeramone
Copy link
Contributor Author

I guess the fact that we don't require an OBBject anymore broke the API Reference generator

Traceback (most recent call last):
  File "/home/runner/work/openbb-docs/openbb-docs/scripts/generate_platform_markdown.py", line 696, in <module>
    generate_platform_markdown(obb.reference.get("paths", {}))
  File "/home/runner/work/openbb-docs/openbb-docs/scripts/generate_platform_markdown.py", line 637, in generate_platform_markdown
    path_data["returns"]["OBBject"]
KeyError: 'OBBject'

Ya, a band-aid has already been applied for this. The PR refactors this script to improve the presentation of the Reference sections.

@deeleeramone deeleeramone merged commit 05842d7 into main Apr 7, 2025
2 checks passed
@piiq piiq deleted the update-platform-arch branch June 20, 2025 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants