Docstrings not showing correctly

Which version are you running? The lastest version is on Github. Pip is for major releases.

0.3.14b0

Describe the bug Running help(pta.adx) will correctly show the __doc__.

However, the way docstrings are assigned (manually assigning to __doc__ of the function) causes IDE completion to not show the docstring correctly.

To Reproduce Use VSCode with python extension, use virtualenv with pandas_ta installed and use a very simple sample-snippet like the below.

import pandas_ta as pta

pta.adx

Uppon opening the parenteses after ADX, the docstring should show. Also on hover on the method, the docstring should show (but only the “one line” after the function header is showing).

Expected behavior Docstring will also show up as part of the autocompletion.

Screenshots

Same behaviour also shows on pycharm - so it’s apparently not an editor issue.

Additional context One can argue that it’s a problem of the the IDE - but it works fine for other packages …

On top of this, IDE completion for “Dataframe extension mode” does not work at all … but i suspect that’s an issue with pandas more than with pandas_ta).

Also - i think it would be nice to have a “full” documentation build based on the available docstrings that’s available as website (like readthedocs.io or github pages…). While it’ll seem sufficient to point users to “run help(pta.adx)” - having a webpage that allows to search for things in a “decently rendered” way would improve usability.

[xmatthias]

seems to work great (although i must admit, i’ve only tested a handful of indicators i commonly use) 👍

[twopirllc]

@pssolanki111,

i used shpinx to build the docs for my library (for polygon.io financial data APIs) and it works so well.

I am aware of Sphinx, just little xp with it. Thanks for providing reference links. 😎

Thanks, KJ