Does sphinx autodoc work with param?

Param
1

If I made a parameterized class, does it work with sphinx’s autodoc?

4 Likes
2

I have not tried it but my guess is that the normal things like docstrings from classes and functions would work.

But the doc attribute on the parameters would not be included. But I would also like to know as I’m also using Sphinx for documentation. Just not autodoc yet.

1 Like
3

Hi @ahuang11

Did you get something working? I’m asking because now I would like to try something like that out.

4

I don’t think it did if I recall correctly, but I forget; it’s been a while.

1 Like
5

Hi - Is there any news about this? How are the docs for the param package itself produced?

I have a small param-based package that I need to document so it would be great if there was some way to get the parameter docs into the sphinx output.

6

Did someone actually get autodoc to work with param.Parameterized subclasses?

@JonathanMair Or did you find some other way to document the project?

7

Is the below relevant? It was published yesterday. Correction: it appears all posts on this website are currently dated to 20 october 2024.

8

Does that work? Not sure if it feels like it was written by an LLM?

9

On reflection, and looking at some other articles you are probably right. Just saw the title quickly in passing and pasted the link…