Closed joeced closed 1 year ago
bummer ☹️
@mikofski yeah :) ... I'll will look into it!
So this isn't a fundamental fix of this issue, but I have a workaround that I use for this case. The part that matter for me is the function/module signature. I usually try to get
some_name_I_want.function_name(var1,var2)
independent of the folder structure anyway. One can control this behavior by updating
.. autofunction test_data.@ClassFolder.classMethod
:module: some_name_I_want
I made the update in autodoc itself, but one could overload the
Hi, so this was a hack I suppose rather than a bug or a feature. In other words, I was aware of this issue when I added class folders. See the test docs for class folders here they were rendered with the "@" symbol . And evidently I was also lazy about using automethod
so the hack was to just use autofunction
instead. You can see it here in the index rst file. Some times I just did the easiest thing to get it done. Sorry. But I think this shouldn't be to hard to clean up?
For classes defined in class folders,
@ClassFolder
, methods defined in separate files in the folder need to useautofunction
, rather thanautomethod
. Further, the rendering is different.For instance the
classMethod
must use.. autofunction:: classMethod
and is rendered asWhere the
method_inside_class
must use.. automethod:: ClassFolder.method_inside_classdef
and is rendered as