Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Tiago Peixoto
graph-tool
Commits
6e3cc364
Commit
6e3cc364
authored
Feb 02, 2011
by
Tiago Peixoto
Browse files
Documentation improvements
parent
59bdb757
Changes
3
Hide whitespace changes
Inline
Side-by-side
doc/conf.py
View file @
6e3cc364
...
...
@@ -28,8 +28,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx'
,
'mathjax'
,
'sphinx.ext.autosummary'
,
'sphinxext.numpydoc'
,
'sphinx.ext.extlinks'
]
numpydoc_show_class_members
=
False
mathjax_path
=
"MathJax/MathJax.js"
# Add any paths that contain templates here, relative to this directory.
...
...
@@ -235,5 +233,8 @@ extlinks = {'ticket': ('http://projects.skewed.de/graph-tool/ticket/%s',
'doi'
:
(
'http://dx.doi.org/%s'
,
'DOI: '
),
'arxiv'
:
(
'http://arxiv.org/abs/%s'
,
'arXiv: '
)}
# autodoc_default_flags = ['members']
numpydoc_show_class_members
=
False
autodoc_member_order
=
'bysource'
autodoc_default_flags
=
[
'members'
]
doc/graph_tool.rst
View file @
6e3cc364
.. automodule:: graph_tool
:members:
.. autoclass:: Graph
:members:
.. autoclass:: GraphView
:show-inheritance:
:members:
.. autoclass:: Vertex
:members:
.. autoclass:: Edge
:members:
.. autoclass:: PropertyMap
:members:
.. autoclass:: PropertyArray
:show-inheritance:
:members: prop_map
.. autofunction:: load_graph
.. autofunction:: group_vector_property
.. autofunction:: ungroup_vector_property
.. autofunction:: value_types
.. autofunction:: show_config
Available subpackages
=====================
...
...
src/graph_tool/__init__.py
View file @
6e3cc364
...
...
@@ -19,8 +19,27 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
``graph_tool`` - efficient graph analysis and manipulation
===========================================================
graph_tool - efficient graph analysis and manipulation
======================================================
Summary
-------
.. autosummary::
:nosignatures:
Graph
GraphView
Vertex
Edge
PropertyMap
PropertyArray
load_graph
group_vector_property
ungroup_vector_property
value_types
show_config
This module provides:
...
...
@@ -52,26 +71,8 @@ Use the built-in ``help`` function to view a function's docstring::
>>> help(gt.Graph)
Summary
-------
.. autosummary::
:nosignatures:
Graph
GraphView
Vertex
Edge
PropertyMap
load_graph
group_vector_property
ungroup_vector_property
value_types
show_config
PropertyArray
Classes
-------
Contents
--------
"""
__author__
=
"Tiago de Paula Peixoto <tiago@skewed.de>"
...
...
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