From 117063da85d36da4542128e8e54bb2e14c46c3db Mon Sep 17 00:00:00 2001 From: David Halter Date: Mon, 4 Feb 2013 15:14:26 +0100 Subject: [PATCH] sphinx dev: core extensions description --- docs/docs/development.rst | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 9c12d5e5..f3606da3 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -69,16 +69,34 @@ Evaluation of python code (evaluate.py) Core Extensions --------------- -Docstrings (docstrings.py) -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Core Extensions is a summary of the following topics: -.. automodule:: docstrings +- :ref:`Dynamic Arrays & Function Parameters ` +- :ref:`Docstrings ` +- :ref:`Refactoring ` + +These topics are very important to understand what Jedi additionally does, but +they could be removed from Jedi and Jedi would still work. But logically +without refactoring support, docstrings and the understanding of the dynamic +nature of Python. + + +.. _dev-dynamic: Dynamic Arrays & Function Parameters (dynamic.py) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: dynamic +.. _dev-docstrings: + +Docstrings (docstrings.py) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: docstrings + +.. _dev-refactoring: + Refactoring (docstrings.py) ~~~~~~~~~~~~~~~~~~~~~~~~~~~