The @ray.remote decorator breaks Sphinx autoclass extension.

System information

• OS Platform and Distribution (e.g., Linux Ubuntu 16.04): Mac OS X 10.13.5
• Ray installed from (source or binary): both
• Ray version: 0.5.0
• Python version: Python 2.7.10
• Exact command to reproduce: See below.

Describe the problem

Ray decorators breaks Sphinx autoclass extension.

If a class is decorated and documented using docstrings, documentation is not generated. The MyClass class can still be imported by Sphinx.

@ray.remote(num_gpus=1)
class MyClass(object):
    """ lorum ipsum """

...

I use the Sphinx extension sphinx.ext.autodoc to build my documentation.

See also Civilize your Python @decorators

Source code / logs

To reproduce this issue, run the following inside a virtualenv or similar:

git clone [e-mail]:martisak/ray_decorator_issue.git 
pip install -r requirements.txt
make html

Then open build/html/index.html in your favorite browser, which should look like the following.

[simon-mo]

some combination of wraps and overriding __doc__, __signature__ should do it.

[sofietorfs]

I’m using ray version 0.8.2 and python version 3.6.9 and I am experiencing the same problem. I’m quite new to python and sphinx, so I don’t understand the solution. Would it be possible for someone to explain it for me?