1
0
forked from VimPlug/jedi

Trying to fix the docs.

This commit is contained in:
Dave Halter
2017-02-02 23:39:10 +01:00
parent a5a54fbc85
commit f627d541b8
6 changed files with 32 additions and 24 deletions

14
docs/README.md Normal file
View File

@@ -0,0 +1,14 @@
Installation
------------
Install the graphviz library::
sudo apt-get install graphviz
Install sphinx::
sudo pip install sphinx
You might also need to install the Python graphviz interface::
sudo pip install graphviz

View File

@@ -59,27 +59,25 @@ Parser (parser/__init__.py)
.. automodule:: jedi.parser
Parser Representation (parser/representation.py)
Parser Tree (parser/tree.py)
++++++++++++++++++++++++++++++++++++++++++++++++
.. automodule:: jedi.parser.representation
.. automodule:: jedi.parser.tree
Class inheritance diagram:
.. inheritance-diagram::
SubModule
Module
Class
Function
Lambda
Flow
ForFlow
ForStmt
Import
Statement
ExprStmt
Param
Call
Array
Name
ListComprehension
CompFor
:parts: 1
.. _evaluate:
@@ -95,12 +93,10 @@ Evaluation Representation (evaluate/representation.py)
.. automodule:: jedi.evaluate.representation
.. inheritance-diagram::
Executable
Instance
InstanceElement
Class
Function
FunctionExecution
jedi.evaluate.instance.TreeInstance
jedi.evaluate.representation.ClassContext
jedi.evaluate.representation.FunctionContext
jedi.evaluate.representation.FunctionExecutionContext
:parts: 1
@@ -133,7 +129,7 @@ Core Extensions is a summary of the following topics:
- :ref:`Iterables & Dynamic Arrays <iterables>`
- :ref:`Dynamic Parameters <dynamic>`
- :ref:`Fast Parser <fast_parser>`
- :ref:`Diff Parser <diff-parser>`
- :ref:`Docstrings <docstrings>`
- :ref:`Refactoring <refactoring>`
@@ -147,7 +143,7 @@ Iterables & Dynamic Arrays (evaluate/iterable.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To understand Python on a deeper level, |jedi| needs to understand some of the
dynamic features of Python, however this probably the most complicated part:
dynamic features of Python like lists that are filled after creation:
.. automodule:: jedi.evaluate.iterable
@@ -160,12 +156,12 @@ Parameter completion (evaluate/dynamic.py)
.. automodule:: jedi.evaluate.dynamic
.. _fast_parser:
.. _diff-parser:
Fast Parser (parser/fast.py)
Diff Parser (parser/diff.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: jedi.parser.fast
.. automodule:: jedi.parser.diff
.. _docstrings:

View File

@@ -42,8 +42,8 @@ The specified Python version just refers to the *runtime environment* for
use) under Python 2. Otherwise, use the Python 3 version. But whatever version
you choose, both are able to complete both Python 2 and 3 *code*.
(There is also a packaged version of the vim plugin available: `vim-jedi at
Arch Linux<https://www.archlinux.org/packages/community/any/vim-jedi/>`__.)
(There is also a packaged version of the vim plugin available:
`vim-jedi at Arch Linux <https://www.archlinux.org/packages/community/any/vim-jedi/>`__.)
Debian
~~~~~~

View File

@@ -92,7 +92,7 @@ and one that uses ``PYTHONSTARTUP``.
Using ``PYTHONSTARTUP``
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: jedi.replstartup
.. automodule:: jedi.api.replstartup
Using a custom ``$HOME/.pythonrc.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -34,7 +34,6 @@ py__get__(call_object) Only on instances. Simulates
descriptors.
====================================== ========================================
__
"""
import os
import pkgutil

View File

@@ -62,7 +62,6 @@ definitely worse in some cases. But a completion should also be fast.
.. autodata:: max_function_recursion_level
.. autodata:: max_executions_without_builtins
.. autodata:: max_executions
.. autodata:: max_dynamic_params_depth
.. autodata:: scale_call_signatures