search

readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
432 stars 128 forks source link

Some Google Docstrings are not displaying correctly #383

Closed tony-res closed 1 year ago

tony-res commented 1 year ago

Really love this library as it makes things so much easier.

I am though having an issue with some of the Google Docstrings being displayed incorrectly. The doc ends us running together all of the arguments into one long string as seen here:

image

I think I am correctly formatting the Google DocString. Some functions display correctly.

image

Is there something I am doing incorrectly? Maybe DocStrings are not fully supported??

tony-res commented 1 year ago

I think I just needed to add the Napoleon stuff. That seems to correct the behavior.

So in conf.py I added extensions = ["autoapi.extension", "sphinx.ext.napoleon"] and then in my build environment I did pip install sphinx sphinx-autoapi sphinx_rtd_theme sphinxcontrib-napoleon