From 9023d01dcb9c8c034c8b218b10a602030fe355e1 Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 31 Aug 2013 18:04:07 +0430 Subject: [PATCH] jedi settings should have its own documentation page, #212 --- docs/docs/plugin-api.rst | 4 ---- docs/docs/settings.rst | 6 ++++++ docs/index.rst | 1 + jedi/settings.py | 5 ++--- 4 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 docs/docs/settings.rst diff --git a/docs/docs/plugin-api.rst b/docs/docs/plugin-api.rst index 07af1e45..de75b9bd 100644 --- a/docs/docs/plugin-api.rst +++ b/docs/docs/plugin-api.rst @@ -31,10 +31,6 @@ API Return Classes :members: :undoc-members: -Settings Module -~~~~~~~~~~~~~~~ - -.. automodule:: settings Examples -------- diff --git a/docs/docs/settings.rst b/docs/docs/settings.rst new file mode 100644 index 00000000..59a8e332 --- /dev/null +++ b/docs/docs/settings.rst @@ -0,0 +1,6 @@ +.. include:: ../global.rst + +Settings +======== + +.. automodule:: settings diff --git a/docs/index.rst b/docs/index.rst index aaf46a70..e7f4dffe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ Docs docs/repl docs/recipes docs/plugin-api + docs/settings docs/history docs/development docs/testing diff --git a/jedi/settings.py b/jedi/settings.py index c8a335f8..54e801e9 100644 --- a/jedi/settings.py +++ b/jedi/settings.py @@ -1,7 +1,6 @@ """ -This module contains variables with global |jedi| setting. To change the -behavior of |jedi|, change the variables defined in -:mod:`jedi.settings`. +This module contains variables with global |jedi| settings. To change the +behavior of |jedi|, change the variables defined in :mod:`jedi.settings`. Plugins should expose an interface so that the user can adjust the configuration.