pydata-sphinx-theme
pydata-sphinx-theme copied to clipboard
pydata
Field lists render extra colon
It seems with recent versions, that field lists render an extra (unnecessary) colon, and that this change happened between 0.8.1 and 0.9
https://pydata-sphinx-theme.readthedocs.io/en/v0.9.0/demo/kitchen-sink/lists-and-tables.html
https://pydata-sphinx-theme.readthedocs.io/en/v0.8.1/demo/kitchen-sink/lists-and-tables.html
I don't see the double colons on https://pydata-sphinx-theme.readthedocs.io/en/v0.9.0/demo/kitchen-sink/lists-and-tables.html#field-list
or on the development version https://pydata-sphinx-theme.readthedocs.io/en/latest/examples/kitchen-sink/lists.html#field-list
@bryevdv Do you still see what you showed in your images when you go to the links above? I took screenshots of what I see. I am confused why we are seeing different things. I checked with firefox 94 and chrome 103.
Do you have a link to the bokeh development docs where you see the problem?
OK that's nuts, they have been on the bokeh docs with double colons for months at:
https://docs.bokeh.org/en/dev-3.0/docs/gallery/marker_map.html
See screenshot in linked issue. But now suddenly, just today, they are gone. They were there last night, and I grabbed the screenshots from theme docs, at the links above, last night. 🤷
Hmm, that is very odd. I am going to keep this open for a bit longer to see if anyone else sees this issue, if it reappears, or if someone may be able to provide some insight into what's going on.
OK, it's suddenly back again just now at https://docs.bokeh.org/en/dev-3.0/docs/examples/plotting/marker_map.html
It doesn't go away after a force-reload and I see it on Chrome and Safari so it's not some weird browser configuration. I really have no ideas what could be going on all.
It definitely does seem to "be there" (span "colon" with a colon, plus the ::after)
I will make sure everything is up to data and try re-deploying these soon. Not sure what else to try.
I think this is what is causing the issue: https://github.com/sphinx-doc/sphinx/issues/10594
You should be able to fix this by using Sphinx 5.1+. I would also recommend using numpydoc instead of sphinx.ext.napoleon. If there is an issue with numpydoc, we would love to know.
@jarrodmillman thanks for figuring this out! Does numpydoc support the Google docstring format these days? That would be a requirement for switching.
@bryevdv I should have checked what docstring standard you were using first. Thanks for explaining.