mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-07 22:44:27 +08:00
sphinx development docs beginning
This commit is contained in:
86
docs/docs/development.rst
Normal file
86
docs/docs/development.rst
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
.. include:: ../global.rst
|
||||||
|
|
||||||
|
Jedi Development
|
||||||
|
==============
|
||||||
|
|
||||||
|
.. currentmodule:: jedi
|
||||||
|
|
||||||
|
.. note:: This documentation is for Jedi developers, who want to improve Jedi
|
||||||
|
itself, but have just no idea how Jedi works. If you want to use Jedi for
|
||||||
|
your IDE, look at the `plugin api <plugin-api`.
|
||||||
|
|
||||||
|
|
||||||
|
Core
|
||||||
|
----
|
||||||
|
|
||||||
|
API (api.py and api_classes.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Api
|
||||||
|
|
||||||
|
Parsing of python code (parsing.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: parsing
|
||||||
|
|
||||||
|
Evaluation of python code (evaluate.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: evaluate
|
||||||
|
|
||||||
|
Caching (cache.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: cache
|
||||||
|
|
||||||
|
|
||||||
|
Imports and Modules
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Modules (modules.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: module
|
||||||
|
|
||||||
|
Builtin Modules (builtin.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: builtin
|
||||||
|
|
||||||
|
Imports (imports.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: imports
|
||||||
|
|
||||||
|
|
||||||
|
Extensions
|
||||||
|
----------
|
||||||
|
|
||||||
|
Docstrings (docstrings.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: docstrings
|
||||||
|
|
||||||
|
Dynamic Arrays & Function Parameters (dynamic.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: dynamic
|
||||||
|
|
||||||
|
Refactoring (docstrings.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: refactoring
|
||||||
|
|
||||||
|
|
||||||
|
Helpers Modules
|
||||||
|
---------------
|
||||||
|
|
||||||
|
There are some helper modules: `common.py`, `helpers.py`, `debug.py`,
|
||||||
|
`keywords.py`, which I won't describe further. Some functions are inheritely
|
||||||
|
important and central for Jedi to work, but not important to understand how
|
||||||
|
Jedi works.
|
||||||
|
|
||||||
|
Python 2/3 compatibility (_compatibility.py)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. automodule:: _compatibility
|
||||||
@@ -24,6 +24,7 @@ Docs
|
|||||||
docs/features
|
docs/features
|
||||||
docs/plugin-api
|
docs/plugin-api
|
||||||
docs/history
|
docs/history
|
||||||
|
docs/development
|
||||||
|
|
||||||
|
|
||||||
.. _resources:
|
.. _resources:
|
||||||
|
|||||||
Reference in New Issue
Block a user