Commit 6e3cc364 authored by Tiago Peixoto's avatar Tiago Peixoto
Browse files

Documentation improvements

parent 59bdb757
...@@ -28,8 +28,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', ...@@ -28,8 +28,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'mathjax', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'mathjax', 'sphinx.ext.autosummary',
'sphinxext.numpydoc', 'sphinx.ext.extlinks'] 'sphinxext.numpydoc', 'sphinx.ext.extlinks']
numpydoc_show_class_members = False
mathjax_path = "MathJax/MathJax.js" mathjax_path = "MathJax/MathJax.js"
# Add any paths that contain templates here, relative to this directory. # 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', ...@@ -235,5 +233,8 @@ extlinks = {'ticket': ('http://projects.skewed.de/graph-tool/ticket/%s',
'doi': ('http://dx.doi.org/%s', 'DOI: '), 'doi': ('http://dx.doi.org/%s', 'DOI: '),
'arxiv': ('http://arxiv.org/abs/%s', 'arXiv: ')} 'arxiv': ('http://arxiv.org/abs/%s', 'arXiv: ')}
# autodoc_default_flags = ['members']
numpydoc_show_class_members = False
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
autodoc_default_flags = ['members']
.. automodule:: graph_tool .. automodule:: graph_tool
:members:
.. autoclass:: Graph
:members:
.. autoclass:: GraphView .. autoclass:: GraphView
:show-inheritance: :show-inheritance:
:members:
.. autoclass:: Vertex
:members:
.. autoclass:: Edge
:members:
.. autoclass:: PropertyMap
:members:
.. autoclass:: PropertyArray .. autoclass:: PropertyArray
:show-inheritance: :show-inheritance:
:members: prop_map :members: prop_map
.. autofunction:: load_graph
.. autofunction:: group_vector_property
.. autofunction:: ungroup_vector_property
.. autofunction:: value_types
.. autofunction:: show_config
Available subpackages Available subpackages
===================== =====================
......
...@@ -19,8 +19,27 @@ ...@@ -19,8 +19,27 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # 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: This module provides:
...@@ -52,26 +71,8 @@ Use the built-in ``help`` function to view a function's docstring:: ...@@ -52,26 +71,8 @@ Use the built-in ``help`` function to view a function's docstring::
>>> help(gt.Graph) >>> help(gt.Graph)
Summary Contents
------- --------
.. autosummary::
:nosignatures:
Graph
GraphView
Vertex
Edge
PropertyMap
load_graph
group_vector_property
ungroup_vector_property
value_types
show_config
PropertyArray
Classes
-------
""" """
__author__ = "Tiago de Paula Peixoto <tiago@skewed.de>" __author__ = "Tiago de Paula Peixoto <tiago@skewed.de>"
......
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