Make sure both class and __init__ docstring are included

[erikkemperman]

As mentioned in #270 (comment).

By the way, I'm getting warnings about the guzzle theme, it appears they're using an outdated means of injecting script. I've created an issue.

Also, as part of the "final pass" of the docs, I think it would be good to change references to classes and methods using the appropriate markup, this will render them properly and link where possible.

And speaking about links, I will see if I can get the cross-links to work for function parameter types, today. I think that would be a great improvement, but maybe that's just me...

[coveralls]

Coverage remained the same at 92.607% when pulling f48c6c9 on erikkemperman:docstring-init into 7edf352 on ReactiveX:master.

[MainRo]

Also, as part of the "final pass" of the docs, I think it would be good to change references to classes and methods using the appropriate markup, this will render them properly and link where possible.

Sure. I thought I used the correct syntax (I did not find another way to do it). If this is not correct let's fix it.

[erikkemperman]

I thought I used the correct syntax

It's something like :class:`MyClass` I think, although it would sometimes need package prefix as well. I'm not saying it was done incorrectly, by the way, just that I notice some class names and functions which are not yet annotated this way.

I tried again to make the cross-linking work for function arguments and return types, but I guess I simply don't understand why the sphinx-apidoc-generated .rst files work and the manual ones that we have currently don't work.

So, I don't know how to resolve this... Well, I'm assuming that we don't want to throw away all the manually organized rst files in favour of a boring tree like this:

[erikkemperman]

Actually, on second thought... In addition to __init__, perhaps all dunderscore methods ought to be included, if docstrings are provided?

# Include a separate entry for special methods, like __init__, where provided.
autodoc_default_options = {
    'member-order': 'bysource',
    'special-members': True,
    'exclude-members': '__dict__,__weakref__'
}

[erikkemperman]

@MainRo Yes I guess I would like all dunderscore methods, when docstrings are provided, to be included by sphinx. I've amended this PR, but since it changed after you approved it, maybe you want to reconsider or reaffirm?

[erikkemperman]

Thanks!