Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
graph-tool
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
40
Issues
40
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Tiago Peixoto
graph-tool
Commits
c6dc8cf7
Commit
c6dc8cf7
authored
Jun 08, 2015
by
Tiago Peixoto
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Simple documentation fixes
parent
ef2fae83
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
26 additions
and
23 deletions
+26
-23
doc/conf.py
doc/conf.py
+10
-9
doc/draw.rst
doc/draw.rst
+8
-6
doc/graph_tool.rst
doc/graph_tool.rst
+1
-1
src/graph_tool/collection/__init__.py
src/graph_tool/collection/__init__.py
+2
-2
src/graph_tool/community/nested_blockmodel.py
src/graph_tool/community/nested_blockmodel.py
+3
-3
src/graph_tool/draw/gtk_draw.py
src/graph_tool/draw/gtk_draw.py
+2
-2
No files found.
doc/conf.py
View file @
c6dc8cf7
...
...
@@ -26,7 +26,7 @@ sys.path.append(os.path.abspath('.'))
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions
=
[
'sphinx.ext.autodoc'
,
'sphinx.ext.doctest'
,
'sphinx.ext.intersphinx'
,
'mathjax'
,
'sphinx.ext.autosummary'
,
'
sphinxext.
numpydoc'
,
'numpydoc'
,
'sphinx.ext.extlinks'
,
'sphinx.ext.viewcode'
#'sphinx.ext.linkcode'
...
...
@@ -209,15 +209,15 @@ extlinks = {'ticket': ('http://graph-tool.skewed.de/tickets/ticket/%s',
'arxiv'
:
(
'http://arxiv.org/abs/%s'
,
'arXiv: '
)}
def
process_docstring
(
app
,
what
,
name
,
obj
,
options
,
lines
):
for
i
,
line
in
enumerate
(
lines
):
if
"arg1"
in
line
and
"->"
in
line
:
lines
[
i
]
=
""
if
"C++ signature :"
in
line
or
"graph_tool::Python"
in
line
:
lines
[
i
]
=
""
#
def process_docstring(app, what, name, obj, options, lines):
#
for i, line in enumerate(lines):
#
if "arg1" in line and "->" in line:
#
lines[i] = ""
#
if "C++ signature :" in line or "graph_tool::Python" in line:
#
lines[i] = ""
def
setup
(
app
):
app
.
connect
(
'autodoc-process-docstring'
,
process_docstring
)
#
def setup(app):
#
app.connect('autodoc-process-docstring', process_docstring)
# plot directive
import
pyenv
...
...
@@ -229,6 +229,7 @@ numpydoc_show_class_members = False
autodoc_docstring_signature
=
False
autodoc_member_order
=
'bysource'
autoclass_content
=
'both'
imported_members
=
True
def
linkcode_resolve
(
domain
,
info
):
if
domain
!=
'py'
:
...
...
doc/draw.rst
View file @
c6dc8cf7
.. automodule:: graph_tool.draw
:no-members:
Layout algorithms
=================
.. container:: sec_title
Layout algorithms
.. autofunction:: sfdp_layout
.. autofunction:: fruchterman_reingold_layout
...
...
@@ -11,9 +12,9 @@
.. autofunction:: random_layout
Graph drawing
=============
.. container:: sec_title
Graph drawing
.. autofunction:: graph_draw
.. autofunction:: draw_hierarchy
...
...
@@ -22,8 +23,9 @@
.. autofunction:: get_hierarchy_control_points
Low-level graph drawing
^^^^^^^^^^^^^^^^^^^^^^^
.. container:: sec_title
Low-level graph drawing
.. autofunction:: cairo_draw
.. autofunction:: interactive_window
...
...
doc/graph_tool.rst
View file @
c6dc8cf7
...
...
@@ -182,7 +182,7 @@
.. autofunction:: group_vector_property
.. autofunction:: ungroup_vector_property
.. autofunction:: infect_vertex_property
.. autofunction:: edge_
difference
.. autofunction:: edge_
endpoint_property
.. autofunction:: value_types
.. autofunction:: show_config
...
...
src/graph_tool/collection/__init__.py
View file @
c6dc8cf7
...
...
@@ -33,8 +33,8 @@ This module contains an assortment of useful networks.
or alternatively in the ``"description"`` graph property which accompanies
each graph object.
Examples
--------
Examples
========
>>> g = gt.collection.data["karate"]
>>> print(g)
...
...
src/graph_tool/community/nested_blockmodel.py
View file @
c6dc8cf7
...
...
@@ -1434,7 +1434,7 @@ def minimize_nested_blockmodel_dl(g, Bs=None, bs=None, min_B=None,
entropy will be used to compare different partitions.
sequential : ``bool`` (optional, default: ``True``)
If ``True``, the move attempts on the vertices are done in sequential
random order. Otherwise a total of `
N
` moves attempts are made, where
random order. Otherwise a total of `
`N`
` moves attempts are made, where
`N` is the number of vertices, where each vertex can be selected with
equal probability.
checkpoint : function (optional, default: ``None``)
...
...
@@ -1448,8 +1448,8 @@ def minimize_nested_blockmodel_dl(g, Bs=None, bs=None, min_B=None,
...
where `state` is either a :class:`~graph_tool.community.NestedBlockState`
instance or ``None``, `L` is the current description length, `
delta
` is
the entropy difference in the last MCMC sweep, and `
nmoves
` is the
instance or ``None``, `L` is the current description length, `
`delta`
` is
the entropy difference in the last MCMC sweep, and `
`nmoves`
` is the
number of accepted block membership moves. The ``minimize_state``
argument is a :class:`~graph_tool.community.NestedMinimizeState`
instance which specifies the current state of the algorithm, which can
...
...
src/graph_tool/draw/gtk_draw.py
View file @
c6dc8cf7
...
...
@@ -171,7 +171,7 @@ class GraphWidget(Gtk.DrawingArea):
User-supplied callback to be called whenever the positions of the layout
have changed. It needs to have the following signature:
.. code-block::
.. code-block::
python
def callback(g, picked, pos, vprops, eprops):
...
...
...
@@ -185,7 +185,7 @@ class GraphWidget(Gtk.DrawingArea):
User-supplied callback to be called whenever a key-press event has
happened. It needs to have the following signature:
.. code-block::
.. code-block::
python
def callback(g, keyval, picked, pos, vprops, eprops):
...
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment