Sphinx apidocs: fix crosslink issues, polish rx.Observable (#419)

* Remove 'copyright' (ends up double in generated docs)

* Add docstrings to core.typing, include it in API reference

* Fix crosslink issues in sphinx apidocs

* Polish docstring for rx.core.observable.Observable

* Re-order methods in Observable for nicer apidoc

docs/conf.py

@@ -67,6 +67,39 @@
     'exclude-members': '__dict__,__weakref__'
 }
 
+
+# Hack to get crosslinks working where things are available (and referred to) by
+# several paths. E.g. we export rx.Observable but that's not its fully qualified
+# name, and this causes the automatically generated links to fail for the
+# argument / return types of functions (e.g. as defined in rx/__init__.py).
+#
+# It looks as though the intention of sphinx_autodoc_typehints is to include
+# support for something like this in a future version:
+#
+# https://github.com/agronholm/sphinx-autodoc-typehints/issues/38
+
+import sphinx_autodoc_typehints
+
+qualname_overrides = {
+    'rx.core.observable.observable.Observable': 'rx.Observable'
+}
+
+_format_annotation = sphinx_autodoc_typehints.format_annotation
+
+
+def format_annotation(annotation):
+    if isinstance(annotation, type):
+        full_name = f'{annotation.__module__}.{annotation.__qualname__}'
+        override = qualname_overrides.get(full_name)
+        if override is not None:
+            return f':py:class:`~{override}`'
+    return _format_annotation(annotation)
+
+sphinx_autodoc_typehints.format_annotation = format_annotation
+
+# End hack.
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/reference.rst

@@ -12,3 +12,4 @@ Reference
    Subject <reference_subject>
    Scheduler <reference_scheduler>
    Operators <reference_operators>
+   Typing <reference_typing>

docs/reference_observable_factory.rst

@@ -4,4 +4,4 @@ Observable Factory
 =====================
 
 .. automodule:: rx
-    :members:
+    :members:

docs/reference_operators.rst

@@ -4,4 +4,4 @@ Operators
 =========
 
 .. automodule:: rx.operators
-    :members:
+    :members:

docs/reference_typing.rst

@@ -0,0 +1,7 @@
+.. _reference_typing:
+
+Typing
+=======
+
+.. automodule:: rx.core.typing
+    :members:

project.cfg

@@ -6,7 +6,7 @@ version = 3.0.0b4
 description = Reactive Extensions (Rx) for Python
 author = Dag Brattli
 author_email = dag@brattli.net
-copyright = Copyright 2013-2019, Dag Brattli, Microsoft Corp., and Contributors
+copyright = 2013-2019, Dag Brattli, Microsoft Corp., and Contributors
 license = MIT License
 url = http://reactivex.io
 download_url = https://github.com/ReactiveX/RxPY