From a711c29b5972e4b64e4e9dc64626b10082ad033e Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Sun, 15 Apr 2018 12:11:06 +0200 Subject: [PATCH] Better overview over functions in the documentation --- docs/docs/api.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/docs/api.rst b/docs/docs/api.rst index 60890e6b..9658cf7f 100644 --- a/docs/docs/api.rst +++ b/docs/docs/api.rst @@ -27,7 +27,14 @@ The deprecation process is as follows: API documentation ----------------- -The API can generally +The API consists of a few different parts: + +- The main starting points for completions/goto: :class:`.Script` and :class:`.Interpreter` +- Helpful functions: :func:`.names`, :func:`.preload_module` and + :func:`.set_debug_function` +- :ref:`API Result Classes ` +- :ref:`Python Versions/Virtualenv Support ` with functions like + :func:`.find_system_environments` and :func:`.find_virtualenvs` .. _api: