Commit 6508fba3 authored by Tiago Peixoto's avatar Tiago Peixoto
Browse files

Sphinx documentation configuration change

parent 00ea6536
......@@ -205,11 +205,6 @@ extlinks = {'ticket': ('http://graph-tool.skewed.de/tickets/ticket/%s',
'arxiv': ('http://arxiv.org/abs/%s', 'arXiv: ')}
# autodoc_default_flags = ['members']
numpydoc_show_class_members = False
autodoc_member_order = 'bysource'
autodoc_docstring_signature = False
def process_docstring(app, what, name, obj, options, lines):
for i, line in enumerate(lines):
if "arg1" in line and "->" in line:
......@@ -224,3 +219,8 @@ def setup(app):
import pyenv
plot_rcparams = pyenv.rcParams
#plot_pre_code = open("pyenv.py").read()
autodoc_default_flags = ['members', 'undoc-members']
numpydoc_show_class_members = False
autodoc_docstring_signature = False
autodoc_member_order = 'bysource'
.. automodule:: graph_tool
:no-members:
:no-undoc-members:
.. autoclass:: Graph
:no-members:
:no-undoc-members:
.. automethod:: copy
.. automethod:: copy
.. container:: sec_title
.. container:: sec_title
Iterating over vertices and edges
Iterating over vertices and edges
See :ref:`sec_iteration` for more documentation and examples.
See :ref:`sec_iteration` for more documentation and examples.
.. automethod:: vertices
.. automethod:: edges
.. automethod:: vertices
.. automethod:: edges
.. container:: sec_title
.. container:: sec_title
Obtaining vertex and edge descriptors
Obtaining vertex and edge descriptors
.. automethod:: vertex
.. automethod:: edge
.. automethod:: vertex
.. automethod:: edge
.. container:: sec_title
.. container:: sec_title
Number of vertices and edges
Number of vertices and edges
.. automethod:: num_vertices
.. automethod:: num_edges
.. automethod:: num_vertices
.. automethod:: num_edges
.. container:: sec_title
.. container:: sec_title
Modifying vertices and edges
Modifying vertices and edges
The following functions allow for addition and removal of
vertices in the graph.
The following functions allow for addition and removal of
vertices in the graph.
.. automethod:: add_vertex
.. automethod:: remove_vertex
.. automethod:: add_vertex
.. automethod:: remove_vertex
The following functions allow for addition and removal of
edges in the graph.
The following functions allow for addition and removal of
edges in the graph.
.. automethod:: add_edge
.. automethod:: remove_edge
.. automethod:: add_edge
.. automethod:: remove_edge
.. automethod:: set_fast_edge_removal
.. automethod:: get_fast_edge_removal
.. automethod:: set_fast_edge_removal
.. automethod:: get_fast_edge_removal
The following functions allow for easy removal of vertices of
edges from the graph.
The following functions allow for easy removal of vertices of
edges from the graph.
.. automethod:: clear
.. automethod:: clear_vertex
.. automethod:: clear_edges
.. automethod:: clear
.. automethod:: clear_vertex
.. automethod:: clear_edges
.. container:: sec_title
.. container:: sec_title
Directedness and reversal of edges
Directedness and reversal of edges
.. note::
.. note::
These functions do not actually modify the graph, and are fully
reversible. They are also very cheap, and have an :math:`O(1)`
complexity.
These functions do not actually modify the graph, and are fully
reversible. They are also very cheap, and have an :math:`O(1)`
complexity.
.. automethod:: set_directed
.. automethod:: is_directed
.. automethod:: set_directed
.. automethod:: is_directed
.. automethod:: set_reversed
.. automethod:: is_reversed
.. automethod:: set_reversed
.. automethod:: is_reversed
.. container:: sec_title
.. container:: sec_title
Creation of new property maps
Creation of new property maps
.. automethod:: new_property
.. automethod:: new_vertex_property
.. automethod:: new_edge_property
.. automethod:: new_graph_property
.. automethod:: new_property
.. automethod:: new_vertex_property
.. automethod:: new_edge_property
.. automethod:: new_graph_property
New property maps can be created by copying already existing
ones.
New property maps can be created by copying already existing
ones.
.. automethod:: copy_property
.. automethod:: copy_property
.. automethod:: degree_property_map
.. automethod:: degree_property_map
.. container:: sec_title
.. container:: sec_title
Index property maps
Index property maps
.. autoattribute:: vertex_index
.. autoattribute:: edge_index
.. autoattribute:: max_edge_index
.. automethod:: reindex_edges
.. autoattribute:: vertex_index
.. autoattribute:: edge_index
.. autoattribute:: max_edge_index
.. automethod:: reindex_edges
.. container:: sec_title
.. container:: sec_title
Internal property maps
Internal property maps
Internal property maps are just like regular property maps, with
the only exception that they are saved and loaded to/from files
together with the graph itself. See :ref:`internal property maps <sec_internal_props>`
for more details.
Internal property maps are just like regular property maps, with
the only exception that they are saved and loaded to/from files
together with the graph itself. See :ref:`internal property maps <sec_internal_props>`
for more details.
.. note::
.. note::
All dictionaries below are mutable. However, any dictionary
returned below is only an one-way proxy to the internally-kept
properties. If you modify this object, the change will be
propagated to the internal dictionary, but not
vice-versa. Keep this in mind if you intend to keep a copy of
the returned object.
All dictionaries below are mutable. However, any dictionary
returned below is only an one-way proxy to the internally-kept
properties. If you modify this object, the change will be
propagated to the internal dictionary, but not
vice-versa. Keep this in mind if you intend to keep a copy of
the returned object.
.. autoattribute:: properties
.. autoattribute:: vertex_properties
.. autoattribute:: vp
.. autoattribute:: edge_properties
.. autoattribute:: ep
.. autoattribute:: graph_properties
.. autoattribute:: gp
.. automethod:: list_properties
.. autoattribute:: properties
.. autoattribute:: vertex_properties
.. autoattribute:: vp
.. autoattribute:: edge_properties
.. autoattribute:: ep
.. autoattribute:: graph_properties
.. autoattribute:: gp
.. automethod:: list_properties
.. container:: sec_title
.. container:: sec_title
Filtering of vertices and edges.
Filtering of vertices and edges.
See :ref:`sec_graph_filtering` for more details.
See :ref:`sec_graph_filtering` for more details.
.. note::
.. note::
These functions do not actually modify the graph, and are fully
reversible. They are also very cheap, and have an :math:`O(1)`
complexity.
These functions do not actually modify the graph, and are fully
reversible. They are also very cheap, and have an :math:`O(1)`
complexity.
.. automethod:: set_vertex_filter
.. automethod:: get_vertex_filter
.. automethod:: set_edge_filter
.. automethod:: get_edge_filter
.. automethod:: set_vertex_filter
.. automethod:: get_vertex_filter
.. automethod:: set_edge_filter
.. automethod:: get_edge_filter
.. warning::
.. warning::
The purge functions below irreversibly remove the filtered
vertices or edges from the graph, and return it to an
unfiltered state. Note that, contrary to the functions above,
these are :math:`O(V)` and :math:`O(E)` operations,
respectively.
The purge functions below irreversibly remove the filtered
vertices or edges from the graph, and return it to an
unfiltered state. Note that, contrary to the functions above,
these are :math:`O(V)` and :math:`O(E)` operations,
respectively.
.. automethod:: purge_vertices
.. automethod:: purge_edges
.. automethod:: purge_vertices
.. automethod:: purge_edges
.. container:: sec_title
.. container:: sec_title
I/O operations
I/O operations
See :ref:`sec_graph_io` for more details.
See :ref:`sec_graph_io` for more details.
.. automethod:: load
.. automethod:: save
.. automethod:: load
.. automethod:: save
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment