Skip to content
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.

Sign up for GitHub

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

Jump to bottom

New format for SDK documentation #3211

Merged
merged 87 commits into from
Nov 9, 2022
Merged

New format for SDK documentation #3211

merged 87 commits into from
Nov 9, 2022

Conversation

montezdesousa
Copy link
Contributor

@montezdesousa montezdesousa commented Oct 31, 2022 •
edited
Loading

Description

This PR changes SDK documentation formatting from .md to .rst to allow a bit more customization.

  • Clean up the generate.py code
  • Extend format to futures menu
  • Extend format to forecast menu
  • Clean buggy docstrings

Before:
image

After:
Screenshot 2022-11-07 at 19 07 52

@montezdesousa
example changes in slopes
a81448e
@montezdesousa
change lettering size and side bar capitalization
ccb2129
@montezdesousa
revert back to Fira
1f25632
@montezdesousa
start automatic website generation
fe76e38
@montezdesousa
this was autogen
f8d70f3
@montezdesousa
add examples to slopes model
4cfe250
@montezdesousa
generate slopes doc
f5f681a
@montezdesousa
change to _index.md
9764dcb
@montezdesousa
allow italic formatting
1d34948
@montezdesousa
fix regex
87a14d6
@montezdesousa
option to regenerate paths
07c9fe8
@montezdesousa
update alt docs
5d1e96a
@montezdesousa
fix generate
976baed
@montezdesousa
update alt
fe3e3ce
@montezdesousa
fix generate
04e110a
@montezdesousa
update common
43f874a
@montezdesousa
target italic only for types
e0cf405
@montezdesousa
format alt
a19c096
@montezdesousa
format italic common
7d71fad
@montezdesousa
add sig indentation
d1c529f
@montezdesousa
update sig indent alt
3f99fe3
@montezdesousa
update common ident
c970d95
@montezdesousa
add todo
1083a8a
@montezdesousa
generate docstrings for all menus
970294d
@montezdesousa
fix maxdd
98fe782
@montezdesousa
fix returns font size
643c6c4
@montezdesousa
fix keys docs
3a33505
@montezdesousa
fix more docstrings
d43942f
@montezdesousa
escape literal symbols
3bbaa45
@montezdesousa
escape literal symbols
72f8697
@montezdesousa montezdesousa marked this pull request as ready for review November 7, 2022 19:04
Chavithra
Chavithra approved these changes Nov 8, 2022
View reviewed changes
Copy link
Contributor

@Chavithra Chavithra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok to me.

@montezdesousa montezdesousa merged commit cd420c5 into main Nov 9, 2022
@montezdesousa montezdesousa deleted the sdk_doc branch November 9, 2022 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Chavithra Chavithra Chavithra approved these changes

Assignees
No one assigned
Labels
docs Code documentation platform OpenBB Platform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@montezdesousa @JerBouma @DidierRLopes @piiq @minhhoang1023 @Chavithra