ranaroussi / yfinance

Download market data from Yahoo! Finance's API
https://aroussi.com/post/python-yahoo-finance
Apache License 2.0
14.89k stars 2.44k forks source link

Improve Sphinx docs #2120

Closed ValueRaider closed 5 days ago

ValueRaider commented 1 week ago

Reorganise new documentation, add some missing content.

@ericpien can you sanity-check this? The changes are mostly AI - lots of warnings but seems to work, not sure how the Action will cope.

ericpien commented 1 week ago

hey @ValueRaider I noticed this was converted to draft. Should I still review as is?

I see the vision in 1. Splitting out Ticker to underlying functions and 2. Changing the class.rst template but the implementation will take some work to rid of the warnings and unnecessary methods like __dict__ and duplicate __init__.

ValueRaider commented 1 week ago

I misuse draft state - we really need another state to mean ready for review but probably not merge.

All warnings fixed.