Debian Codegraph @

docs/index.rst

raw
1 .. include global.rst
2
3 .. meta::
4 :github_url: https://github.com/davidhalter/jedi
5
6 Jedi - an awesome autocompletion, static analysis and refactoring library for Python
7 ====================================================================================
8
9 .. image:: https://img.shields.io/github/stars/davidhalter/jedi.svg?style=social&label=Star&maxAge=2592000
10 :target: https://github.com/davidhalter/jedi
11 :alt: GitHub stars
12
13 .. image:: http://isitmaintained.com/badge/open/davidhalter/jedi.svg
14 :target: https://github.com/davidhalter/jedi/issues
15 :alt: The percentage of open issues and pull requests
16
17 .. image:: http://isitmaintained.com/badge/resolution/davidhalter/jedi.svg
18 :target: https://github.com/davidhalter/jedi/issues
19 :alt: The resolution time is the median time an issue or pull request stays open.
20
21 .. image:: https://github.com/davidhalter/jedi/workflows/ci/badge.svg?branch=master
22 :target: https://github.com/davidhalter/jedi/actions
23 :alt: Tests
24
25 .. image:: https://coveralls.io/repos/davidhalter/jedi/badge.svg?branch=master
26 :target: https://coveralls.io/r/davidhalter/jedi
27 :alt: Coverage status
28
29 .. image:: https://pepy.tech/badge/jedi
30 :target: https://pepy.tech/project/jedi
31 :alt: PyPI Downloads
32
33 `Github Repository <https://github.com/davidhalter/jedi>`_
34
35 .. automodule:: jedi
36
37 Autocompletion can for example look like this in jedi-vim:
38
39 .. figure:: _screenshots/screenshot_complete.png
40
41
42 .. _toc:
43
44 Docs
45 ----
46
47 .. toctree::
48 :maxdepth: 1
49
50 docs/usage
51 docs/features
52 docs/api
53 docs/api-classes
54 docs/installation
55 docs/settings
56 docs/development
57 docs/testing
58 docs/acknowledgements
59 docs/changelog
60
61
62 .. _resources:
63
64 Resources
65 ---------
66
67 If you want to stay **up-to-date** with releases, please **subscribe** to this
68 mailing list: https://groups.google.com/g/jedi-announce. To subscribe you can
69 simply send an empty email to ``[email protected]``.
70
71 - `Source Code on Github <https://github.com/davidhalter/jedi>`_
72 - `Python Package Index <https://pypi.python.org/pypi/jedi/>`_