xarray docs config - how to get bullet points for args in parameters? #8954
-
Sorry this isn't an xarray question per say but more of a question on the docs conf for xarray. I've got a minimal docs repo where i'm building a minimal conf for docs which mostly matches the xarray docs (https://github.com/raybellwaves/myfavdocs). I believe it's the sphinx.ext.napoleon that generates docs html as follows https://docs.xarray.dev/en/stable/generated/xarray.apply_ufunc.html i.e. it renders bullets points for each arg. I can't quite work out the magic config to have the docs render like that. My docs seems to be defaulting to a numpydoc like config e.g. https://numpy.org/doc/stable/reference/generated/numpy.ndarray.tolist.html#numpy.ndarray.tolist i.e. it has a yellow background and no bullet points for the args Edit: my question seems to be the opposite of https://stackoverflow.com/questions/73207795/sphinx-and-read-the-docs-not-using-numpy-docs-style Cheers, |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
Sorry about the noise. I was just because the function has one arg. Once you have more args you get the bullet points |
Beta Was this translation helpful? Give feedback.
Sorry about the noise. I was just because the function has one arg. Once you have more args you get the bullet points