Refactored green modes documentation and added links for issues and P…

…Rs in conf.py

pytango-110 PyTango workshop @ SOLARIS - list of tasks

doc/conf.py

@@ -244,6 +244,8 @@
 .. _asyncio: https://asyncio.readthedocs.io/en/latest/
 .. _boost-python: http://www.boost.org/libs/python
 .. _PyPi: https://pypi.python.org/pypi/pytango
+.. _issues: https://github.com/tango-controls/pytango/issues
+.. _PRs: https://github.com/tango-controls/pytango/pulls
 
 """
 

doc/contents.rst

@@ -14,7 +14,7 @@ Contents
     start
     quicktour
     ITango <itango>
-    green
+    green_modes/green
     API <api>
     How to <howto>
     FAQ <faq>

doc/faq.rst

@@ -15,14 +15,14 @@ Please also check the `general tango how to <http://www.tango-controls.org/resou
 
 Bug reports are very valuable for the community.
 
-Please open a new issue on the `github issue page <https://github.com/tango-cs/pytango/issues>`_.
+Please open a new issue on the GitHub issues_ page.
 
 
 **How can I contribute to PyTango and the documentation?**
 
 Contribution are always welcome!
 
-You can open pull requests on the `github PR page <https://github.com/tango-cs/pytango/pulls>`_.
+You can open pull requests on the GitHub PRs_ page.
 
 
 **I got a libbost_python error when I try to import tango module...**

doc/green_modes/green.rst

@@ -0,0 +1,26 @@
+.. currentmodule:: tango
+
+Green mode
+==========
+
+PyTango supports cooperative green Tango objects. Since version 8.1 two *green*
+modes have been added: :obj:`~tango.GreenMode.Futures` and
+:obj:`~tango.GreenMode.Gevent`. In version 9.2.0 another one has been
+added: :obj:`~tango.GreenMode.Asyncio`.
+
+The :obj:`~tango.GreenMode.Futures` uses the standard python module
+:mod:`concurrent.futures`.
+The :obj:`~tango.GreenMode.Gevent` mode uses the well known gevent_ library.
+The newest, :obj:`~tango.GreenMode.Asyncio` mode, uses asyncio_ - a Python
+library for asynchronous programming (it's featured as a part of a standard
+Python distribution since version 3.5 of Python; it's available on PyPI for
+older ones).
+
+You can set the PyTango green mode at a global level. Set the environment
+variable :envvar:`PYTANGO_GREEN_MODE` to either *futures* or *gevent*
+(case incensitive). If this environment variable is not defined the PyTango
+global green mode defaults to *Synchronous*.
+
+.. include:: green_modes_client.rst
+
+.. include:: green_modes_server.rst

doc/green.rst → doc/green_modes/green_modes_client.rst

@@ -1,26 +1,3 @@
-.. currentmodule:: tango
-
-Green mode
-==========
-
-PyTango supports cooperative green Tango objects. Since version 8.1 two *green*
-modes have been added: :obj:`~tango.GreenMode.Futures` and
-:obj:`~tango.GreenMode.Gevent`. In version 9.2.0 another one has been
-added: :obj:`~tango.GreenMode.Asyncio`.
-
-The :obj:`~tango.GreenMode.Futures` uses the standard python module
-:mod:`concurrent.futures`.
-The :obj:`~tango.GreenMode.Gevent` mode uses the well known gevent_ library.
-The newest, :obj:`~tango.GreenMode.Asyncio` mode, uses asyncio_ - a Python
-library for asynchronous programming (it's featured as a part of a standard
-Python distribution since version 3.5 of Python; it's available on PyPI for
-older ones).
-
-You can set the PyTango green mode at a global level. Set the environment
-variable :envvar:`PYTANGO_GREEN_MODE` to either *futures* or *gevent*
-(case incensitive). If this environment variable is not defined the PyTango
-global green mode defaults to *Synchronous*.
-
 Client green modes
 ------------------
 

doc/green_modes/green_modes_server.rst

@@ -0,0 +1,8 @@
+Server green modes
+------------------
+
+.. warning::
+   Green modes for the server side are still very much experimental.
+   If you encounter any issues, please report them on the GitHub issues_ page.
+
+PyTango server API currently supports