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

start correcting the documentation

Browse Source
This commit is contained in:
Dave Halter
2014-01-29 21:34:57 +01:00
parent 8660555d7b
commit e904031400
2 changed files with 14 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/docs/development.rst
View File

@@ -84,15 +84,15 @@ Class inheritance diagram:
.. _evaluate: .. _evaluate:
Evaluation of python code (evaluate.py) Evaluation of python code (evaluate/__init__.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate .. automodule:: evaluate
Evaluation Representation (evaluate_representation.py) Evaluation Representation (evaluate/representation.py)
++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. automodule:: evaluate_representation .. automodule:: evaluate.representation
.. inheritance-diagram:: .. inheritance-diagram::
Executable Executable
@@ -100,9 +100,7 @@ Evaluation Representation (evaluate_representation.py)
InstanceElement InstanceElement
Class Class
Function Function
Execution FunctionExecution
Generator
Array
:parts: 1 :parts: 1
.. _dev-api: .. _dev-api:
@@ -139,7 +137,7 @@ without some features.
Dynamic Arrays & Function Parameters (dynamic.py) Dynamic Arrays & Function Parameters (dynamic.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: dynamic .. automodule:: evaluate.dynamic
.. _fast_parser: .. _fast_parser:
@@ -154,7 +152,7 @@ Fast Parser (parser/fast.py)
Docstrings (docstrings.py) Docstrings (docstrings.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: docstrings .. automodule:: evaluate.docstrings
.. _refactoring: .. _refactoring:
@@ -164,7 +162,6 @@ Refactoring (refactoring.py)
.. automodule:: refactoring .. automodule:: refactoring
.. _imports-modules: .. _imports-modules:
Imports & Modules Imports & Modules
@@ -175,26 +172,21 @@ Imports & Modules
- :ref:`Builtin Modules <builtin>` - :ref:`Builtin Modules <builtin>`
- :ref:`Imports <imports>` - :ref:`Imports <imports>`
.. _modules:
Modules (modules.py)
~~~~~~~~~~~~~~~~~~~~
.. automodule:: modules
.. _builtin: .. _builtin:
Builtin Modules (builtin.py) Compiled Modules (compiled.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: builtin .. automodule:: evaluate.compiled
.. _imports: .. _imports:
Imports (imports.py) Imports (imports.py)
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. automodule:: imports .. automodule:: evaluate.imports
@@ -219,7 +211,7 @@ Caching (cache.py)
Recursions (recursion.py) Recursions (recursion.py)
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: recursion .. automodule:: evaluate.recursion

2
docs/docs/plugin-api-classes.rst
View File

@@ -5,6 +5,6 @@
API Return Classes API Return Classes
------------------ ------------------
.. automodule:: api_classes .. automodule:: api.classes
:members: :members:
:undoc-members: :undoc-members: