VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-08 06:44:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

sphinx dev: move api further down

Browse Source
This commit is contained in:
David Halter
2013-02-04 16:11:49 +01:00
parent fbcd58f488
commit e1ab3855fa
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/development.rst
View File

@@ -41,25 +41,14 @@ The Jedi Core
The core of Jedi consists of three parts: The core of Jedi consists of three parts:
- :ref:`API <dev-api>`
- :ref:`Parser <parsing>` - :ref:`Parser <parsing>`
- :ref:`Python code evaluation <evaluate>` - :ref:`Python code evaluation <evaluate>`
- :ref:`API <dev-api>`
Most people are probably interested in `code evaluation <evaluate>`, because Most people are probably interested in `code evaluation <evaluate>`, because
that's where all the magic happens. I need to introduce the ref:`parser that's where all the magic happens. I need to introduce the ref:`parser
<parsing>` first, because evaluate uses it extensively. <parsing>` first, because evaluate uses it extensively.
.. _dev-api:
API (api.py and api_classes.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The API has been designed to be as usable as possible. The documentation can be
found `here <plugin-api.html>`_. The API itself contains little code that needs
to be mentioned here. Generally I'm trying to be conservative with the API.
I'd rather not add new API features if they are not necessary, because it's
much harder to deprecate stuff than to add it later.
.. _parsing: .. _parsing:
Parser (parsing.py) Parser (parsing.py)
@@ -74,6 +63,17 @@ Evaluation of python code (evaluate.py)
.. automodule:: evaluate .. automodule:: evaluate
.. _dev-api:
API (api.py and api_classes.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The API has been designed to be as usable as possible. The documentation can be
found `here <plugin-api.html>`_. The API itself contains little code that needs
to be mentioned here. Generally I'm trying to be conservative with the API.
I'd rather not add new API features if they are not necessary, because it's
much harder to deprecate stuff than to add it later.
.. _core-extensions: .. _core-extensions: