Adda lot of environment documentation to sphinx

2018-04-15 11:25:46 +02:00
parent 336087fcf8
commit bb979a040d
2 changed files with 31 additions and 9 deletions
--- a/docs/docs/plugin-api.rst
+++ b/docs/docs/plugin-api.rst
@@ -34,6 +34,21 @@ API Interface
    :members:
    :undoc-members:

+.. _environments:
+
+Environments
+~~~~~~~~~~~~
+
+.. automodule:: jedi.api.environment
+
+.. autofunction:: jedi.find_system_environments
+.. autofunction:: jedi.find_virtualenvs
+.. autofunction:: jedi.get_system_environment
+.. autofunction:: jedi.create_environment
+.. autofunction:: jedi.get_default_environment
+.. autoexception:: jedi.InvalidPythonEnvironment
+.. autoclass:: jedi.api.environment.Environment
+    :members:

 Examples
 --------