summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAric Hagberg <aric.hagberg@gmail.com>2014-08-15 21:32:58 -0600
committerAric Hagberg <aric.hagberg@gmail.com>2014-08-15 21:32:58 -0600
commit332880d1924471a528519756432ece4c850393bb (patch)
tree6daffaa0ab24ca1593cda8d519e1b5ede010d0d4
parent1e1ea093815d9a884ba4d84ab48fe60bc907b23f (diff)
parentea32d83fb93f35e88665d093a6e4ba13dc55fd63 (diff)
downloadnetworkx-332880d1924471a528519756432ece4c850393bb.tar.gz
Merge pull request #1245 from ysitu/dominating
Add dominating package to documentation
-rw-r--r--doc/source/reference/algorithms.dominating.rst10
-rw-r--r--doc/source/reference/algorithms.rst1
-rw-r--r--networkx/algorithms/dominating.py2
3 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/reference/algorithms.dominating.rst b/doc/source/reference/algorithms.dominating.rst
new file mode 100644
index 00000000..40cb899a
--- /dev/null
+++ b/doc/source/reference/algorithms.dominating.rst
@@ -0,0 +1,10 @@
+***************
+Dominating Sets
+***************
+
+.. automodule:: networkx.algorithms.dominating
+.. autosummary::
+ :toctree: generated/
+
+ dominating_set
+ is_dominating_set
diff --git a/doc/source/reference/algorithms.rst b/doc/source/reference/algorithms.rst
index 6ce11baf..c82c158d 100644
--- a/doc/source/reference/algorithms.rst
+++ b/doc/source/reference/algorithms.rst
@@ -26,6 +26,7 @@ Algorithms
algorithms.dag
algorithms.distance_measures
algorithms.distance_regular
+ algorithms.dominating
algorithms.euler
algorithms.flow
algorithms.graphical
diff --git a/networkx/algorithms/dominating.py b/networkx/algorithms/dominating.py
index 69a6387c..b53bf2f7 100644
--- a/networkx/algorithms/dominating.py
+++ b/networkx/algorithms/dominating.py
@@ -25,7 +25,7 @@ def dominating_set(G, start_with=None):
Notes
-----
- This function is an implementation of algorithm 7 in _[2] which
+ This function is an implementation of algorithm 7 in [2]_ which
finds some dominating set, not necessarily the smallest one.
See also