For using igraph from Python
This document contains the API (Application Programming Interface) documentation for igraph library. Documentation for the Python objects defined by the project is divided into separate pages for each package, module, and class. The API documentation also includes two pages containing information about the project as a whole: a trees page, and an index page.
Each Package Documentation page contains:
Each Module Documentation page contains:
Each Class Documentation page contains:
The Trees page contains the module and class hierarchies:
The Index page contains indices of terms and identifiers:
The table of contents occupies the two frames on the left side of the window. The upper-left frame displays the project contents, and the lower-left frame displays the module contents:
The project contents frame contains a list of all packages and modules that are defined by the project. Clicking on an entry will display its contents in the module contents frame. Clicking on a special entry, labeled "Everything," will display the contents of the entire project.
The module contents frame contains a list of every submodule, class, type, exception, function, and variable defined by a module or package. Clicking on an entry will display its documentation in the API documentation frame. Clicking on the name of the module, at the top of the frame, will display the documentation for the module itself.
The "frames" and "no frames" buttons below the top navigation bar can be used to control whether the table of contents is displayed or not.
A navigation bar is located at the top and bottom of every page. It indicates what type of page you are currently viewing, and allows you to go to related pages. The following table describes the labels on the navigation bar. Note that not some labels (such as [Parent]) are not displayed on all pages.
|Label||Highlighted when...||Links to...|
|[Parent]||(never highlighted)||the parent of the current package|
|[Package]||viewing a package||the package containing the current object|
|[Module]||viewing a module||the module containing the current object|
|[Class]||viewing a class||the class containing the current object|
|[Trees]||viewing the trees page||the trees page|
|[Index]||viewing the index page||the index page|
|[Help]||viewing the help page||the help page|
The "show private" and "hide private" buttons below
the top navigation bar can be used to control whether documentation
for private objects is displayed. Private objects are usually defined
as objects whose (short) names begin with a single underscore, but do
not end with an underscore. For example, "
__pprint", and "
are private objects; but "
__init__", and "
type_" are not. However,
if a module defines the "
__all__" variable, then its
contents are used to decide which objects are private.
A timestamp below the bottom navigation bar indicates when each page was last updated.
|Generated by Epydoc 3.0.1 on Fri May 10 10:51:13 2019||http://epydoc.sourceforge.net|