jedi settings should have its own documentation page, #212

2013-08-31 18:04:07 +04:30
parent 4e9bb0c062
commit 9023d01dcb
4 changed files with 9 additions and 7 deletions
--- 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
 --------
--- a/docs/docs/settings.rst
+++ b/docs/docs/settings.rst
@@ -0,0 +1,6 @@
+.. include:: ../global.rst
+
+Settings
+========
+
+.. automodule:: settings
--- 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
--- 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.