diff options
| author | Claudiu Popa <pcmanticore@gmail.com> | 2018-06-04 08:30:00 -0700 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2018-06-04 08:30:00 -0700 |
| commit | 8be9feb9c25cd3aec2d34ddf172f382af73729b3 (patch) | |
| tree | 226d832bcb268115dc7a18a05f428e6f823ffe39 /doc/api | |
| parent | a4996b4ce7d2a1b651ae984ee3448b8913577c5f (diff) | |
| download | astroid-git-8be9feb9c25cd3aec2d34ddf172f382af73729b3.tar.gz | |
Improve the documentation to ease the discovery of astroid's features
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/astroid.exceptions.rst | 4 | ||||
| -rw-r--r-- | doc/api/astroid.nodes.rst | 4 | ||||
| -rw-r--r-- | doc/api/astroid.rst | 68 | ||||
| -rw-r--r-- | doc/api/general.rst | 5 | ||||
| -rw-r--r-- | doc/api/index.rst | 12 |
5 files changed, 21 insertions, 72 deletions
diff --git a/doc/api/astroid.exceptions.rst b/doc/api/astroid.exceptions.rst index ede67432..bb7b1b19 100644 --- a/doc/api/astroid.exceptions.rst +++ b/doc/api/astroid.exceptions.rst @@ -1,5 +1,5 @@ -:mod:`astroid.exceptions` -========================= +Exceptions +========== .. automodule:: astroid.exceptions diff --git a/doc/api/astroid.nodes.rst b/doc/api/astroid.nodes.rst index 84ceba98..3031c8b5 100644 --- a/doc/api/astroid.nodes.rst +++ b/doc/api/astroid.nodes.rst @@ -1,5 +1,5 @@ -:mod:`astroid.nodes` -==================== +Nodes +===== .. automodule:: astroid.nodes diff --git a/doc/api/astroid.rst b/doc/api/astroid.rst deleted file mode 100644 index 347f63cc..00000000 --- a/doc/api/astroid.rst +++ /dev/null @@ -1,68 +0,0 @@ -:mod:`astroid` -============== - -.. automodule:: astroid - -Submodules ----------- -.. autosummary:: - :toctree: - - astroid.exceptions - astroid.nodes - -Exceptions ----------- -.. currentmodule:: astroid.exceptions - -.. autosummary:: - - AstroidBuildingError - AstroidBuildingException - AstroidError - AstroidImportError - AstroidIndexError - AstroidSyntaxError - AstroidTypeError - AttributeInferenceError - BinaryOperationError - DuplicateBasesError - InconsistentMroError - InferenceError - MroError - NameInferenceError - NoDefault - NotFoundError - OperationError - ResolveError - SuperArgumentTypeError - SuperError - TooManyLevelsError - UnaryOperationError - UnresolvableName - UseInferenceDefault - -.. currentmodule:: astroid - -.. data:: MANAGER - - The manager for doing stuff. - - :type: astroid.manager.AstroidManager - - -.. autoclass:: Uninferable - -.. autofunction:: are_exclusive - -.. autofunction:: builtin_lookup - -.. autofunction:: extract_node - -.. autofunction:: parse - -.. autofunction:: unpack_infer - -.. autofunction:: register_module_extender - -.. autofunction:: inference_tip diff --git a/doc/api/general.rst b/doc/api/general.rst new file mode 100644 index 00000000..90373ae2 --- /dev/null +++ b/doc/api/general.rst @@ -0,0 +1,5 @@ +General API +------------ + +.. automodule:: astroid + diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 00000000..6277acdd --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,12 @@ + +API +=== + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + general + astroid.nodes + base_nodes + astroid.exceptions |