Skip to content

Commit 427d9b1

Browse files
committed
Update docs for dwave-graphs rename
1 parent eb6f0ce commit 427d9b1

File tree

11 files changed

+87
-94
lines changed

11 files changed

+87
-94
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
.. image:: https://codecov.io/gh/dwavesystems/dwave-graphs/branch/main/graph/badge.svg
55
:target: https://codecov.io/gh/dwavesystems/dwave-graphs
66

7-
.. image:: https://circleci.com/gh/dwavesystems/dwave-graphs.svg?style=svg
7+
.. image:: https://circleci.com/gh/dwavesystems/dwave-networkx.svg?style=svg
88
:target: https://circleci.com/gh/dwavesystems/dwave-graphs
99

1010
============
1111
dwave-graphs
1212
============
1313

14-
.. start_dnx_about
14+
.. start_graphs_about
1515
1616
dwave-graphs provides tools for
1717
working with quantum processing unit (QPU) topology graphs, such as the Pegasus
@@ -24,7 +24,7 @@ This example generates a Pegasus graph of the size used by Advantage QPUs.
2424
>>> import dwave.graphs
2525
>>> graph = dwave.graphs.pegasus_graph(16)
2626

27-
.. end_dnx_about
27+
.. end_graphs_about
2828
2929
Installation
3030
============

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS = -q
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = DWaveNetworkx
7+
SPHINXPROJ = dwave
88
SOURCEDIR = .
99
BUILDDIR = build
1010

docs/algorithms.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _dnx_algorithms:
1+
.. _graphs_algorithms:
22

33
==========
44
Algorithms
@@ -7,21 +7,21 @@ Algorithms
77
Implementations of graph-theory algorithms on the D-Wave system and other
88
binary quadratic model samplers.
99

10-
.. currentmodule:: dwave_networkx
10+
.. currentmodule:: dwave.graphs
1111

12-
.. _dnx_canonicalization:
12+
.. _graphs_canonicalization:
1313

1414
Canonicalization
1515
================
1616

17-
.. automodule:: dwave_networkx.algorithms.canonicalization
17+
.. automodule:: dwave.graphs.algorithms.canonicalization
1818

1919
.. autosummary::
2020
:toctree: generated/
2121

2222
canonical_chimera_labeling
2323

24-
.. _dnx_clique:
24+
.. _graphs_clique:
2525

2626
Clique
2727
======
@@ -35,7 +35,7 @@ that for every two vertices in C there exists an edge connecting the two.
3535
:align: center
3636
:scale: 40 %
3737

38-
.. automodule:: dwave_networkx.algorithms.clique
38+
.. automodule:: dwave.graphs.algorithms.clique
3939

4040
.. autosummary::
4141
:toctree: generated/
@@ -44,7 +44,7 @@ that for every two vertices in C there exists an edge connecting the two.
4444
clique_number
4545
is_clique
4646

47-
.. _dnx_coloring:
47+
.. _graphs_coloring:
4848

4949
Coloring
5050
========
@@ -67,7 +67,7 @@ The map-coloring problem is to assign a color to each region of a map
6767

6868
Coloring a map of Canada with four colors.
6969

70-
.. automodule:: dwave_networkx.algorithms.coloring
70+
.. automodule:: dwave.graphs.algorithms.coloring
7171

7272
.. autosummary::
7373
:toctree: generated/
@@ -78,7 +78,7 @@ The map-coloring problem is to assign a color to each region of a map
7878
vertex_color
7979
vertex_color_qubo
8080

81-
.. _dnx_cover:
81+
.. _graphs_cover:
8282

8383
Cover
8484
=====
@@ -96,7 +96,7 @@ edges of the graph are incident to at least one of the vertices in the set.
9696
(the horizontal tile of the Chimera unit cell) and the red set (vertical
9797
tile) connect to all 16 edges of the graph.
9898

99-
.. automodule:: dwave_networkx.algorithms.cover
99+
.. automodule:: dwave.graphs.algorithms.cover
100100

101101
.. autosummary::
102102
:toctree: generated/
@@ -105,7 +105,7 @@ edges of the graph are incident to at least one of the vertices in the set.
105105
min_weighted_vertex_cover
106106
min_vertex_cover
107107

108-
.. _dnx_elimination_ordering:
108+
.. _graphs_elimination_ordering:
109109

110110
Elimination Ordering
111111
====================
@@ -122,7 +122,7 @@ whose neighborhood induces a clique. A perfect elimination ordering is an
122122
ordering of vertices :math:`1..n` such that any vertex :math:`i` is simplicial
123123
for the subset of vertices :math:`i..n`.
124124

125-
.. automodule:: dwave_networkx.algorithms.elimination_ordering
125+
.. automodule:: dwave.graphs.algorithms.elimination_ordering
126126

127127
.. autosummary::
128128
:toctree: generated/
@@ -138,20 +138,20 @@ for the subset of vertices :math:`i..n`.
138138
pegasus_elimination_order
139139
treewidth_branch_and_bound
140140

141-
.. _dnx_markov:
141+
.. _graphs_markov:
142142

143143
Markov Networks
144144
===============
145145

146-
.. automodule:: dwave_networkx.algorithms.markov
146+
.. automodule:: dwave.graphs.algorithms.markov
147147

148148
.. autosummary::
149149
:toctree: generated/
150150

151151
sample_markov_network
152152
markov_network_bqm
153153

154-
.. _dnx_matching:
154+
.. _graphs_matching:
155155

156156
Matching
157157
========
@@ -167,7 +167,7 @@ A matching is a subset of graph edges in which no vertex occurs more than once.
167167
A matching for a Chimera unit cell: no vertex is incident to more than one
168168
edge in the set of blue edges
169169

170-
.. automodule:: dwave_networkx.algorithms.matching
170+
.. automodule:: dwave.graphs.algorithms.matching
171171

172172
.. autosummary::
173173
:toctree: generated/
@@ -177,7 +177,7 @@ A matching is a subset of graph edges in which no vertex occurs more than once.
177177
min_maximal_matching_bqm
178178
min_maximal_matching
179179

180-
.. _dnx_maximum_cut:
180+
.. _graphs_maximum_cut:
181181

182182
Maximum Cut
183183
===========
@@ -195,15 +195,15 @@ between this subset and the remaining vertices is as large as possible.
195195
nodes {4, 5, 6, 7} cuts 16 edges; adding or removing a node decreases the
196196
number of edges between the two complementary subsets of the graph.
197197

198-
.. automodule:: dwave_networkx.algorithms.max_cut
198+
.. automodule:: dwave.graphs.algorithms.max_cut
199199

200200
.. autosummary::
201201
:toctree: generated/
202202

203203
maximum_cut
204204
weighted_maximum_cut
205205

206-
.. _dnx_independent_set:
206+
.. _graphs_independent_set:
207207

208208
Independent Set
209209
===============
@@ -222,7 +222,7 @@ its member pairs.
222222
(vertical tile) are independent sets of the graph, with no blue node
223223
adjacent to another blue node and likewise for red nodes.
224224

225-
.. automodule:: dwave_networkx.algorithms.independent_set
225+
.. automodule:: dwave.graphs.algorithms.independent_set
226226

227227
.. autosummary::
228228
:toctree: generated/
@@ -239,7 +239,7 @@ Helper Functions
239239

240240
maximum_weighted_independent_set_qubo
241241

242-
.. _dnx_partitioning:
242+
.. _graphs_partitioning:
243243

244244
Partitioning
245245
============
@@ -258,14 +258,14 @@ is as small as possible.
258258
and the nodes in red are in the '1' subset. There are no other arrangements
259259
with fewer edges between two equally sized subsets.
260260

261-
.. automodule:: dwave_networkx.algorithms.partition
261+
.. automodule:: dwave.graphs.algorithms.partition
262262

263263
.. autosummary::
264264
:toctree: generated/
265265

266266
partition
267267

268-
.. _dnx_social:
268+
.. _graphs_social:
269269

270270
Social
271271
======
@@ -284,15 +284,15 @@ friendly/hostile interactions between vertices.
284284
cleanly divided into two subsets, {Bob, Eve} and {Alice}, with friendly
285285
relations within each subset and only hostile relations between the subsets.
286286

287-
.. automodule:: dwave_networkx.algorithms.social
287+
.. automodule:: dwave.graphs.algorithms.social
288288

289289
.. autosummary::
290290
:toctree: generated/
291291

292292
structural_imbalance
293293
structural_imbalance_ising
294294

295-
.. _dnx_traveling_salesperson:
295+
.. _graphs_traveling_salesperson:
296296

297297
Traveling Salesperson
298298
=====================
@@ -308,7 +308,7 @@ weighted graph.
308308

309309
A traveling salesperson route of [2, 1, 0, 3].
310310

311-
.. automodule:: dwave_networkx.algorithms.tsp
311+
.. automodule:: dwave.graphs.algorithms.tsp
312312

313313
.. autosummary::
314314
:toctree: generated/

docs/api_ref.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _dnx_api_ref:
1+
.. _graphs_api_ref:
22

33
=============
44
API Reference

docs/conf.py

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
# DWaveNetworkX documentation build configuration file, created by
2-
# sphinx-quickstart on Wed Jul 26 10:55:26 2017.
3-
#
4-
# This file only contains a selection of the most common options. For a full
5-
# list see the documentation:
6-
# https://www.sphinx-doc.org/en/master/usage/configuration.html
7-
81
import os
92
import sys
103
sys.path.insert(0, os.path.abspath('.'))
@@ -32,13 +25,13 @@
3225
master_doc = 'index'
3326

3427
# General information about the project.
35-
project = u'D-Wave NetworkX'
36-
copyright = u'2017, D-Wave Systems Inc'
37-
author = u'D-Wave Systems Inc'
28+
project = u'D-Wave Graphs'
29+
copyright = u'2025, D-Wave Inc'
30+
author = u'D-Wave Inc'
3831

39-
import dwave_networkx
40-
version = dwave_networkx.__version__
41-
release = dwave_networkx.__version__
32+
import dwave.graphs
33+
version = dwave.graphs.__version__
34+
release = dwave.graphs.__version__
4235

4336
language = 'en'
4437

@@ -56,11 +49,11 @@
5649

5750
todo_include_todos = True
5851

59-
modindex_common_prefix = ['dwave_networkx.']
52+
modindex_common_prefix = ['dwave.graphs.']
6053

6154
doctest_global_setup = \
6255
"""
63-
import dwave_networkx as dnx
56+
import dwave.graphs
6457
import networkx as nx
6558
"""
6659

docs/default_sampler.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
.. _dnx_default_sampler:
1+
.. _graphs_default_sampler:
22

33
===============
44
Default sampler
55
===============
66

7-
.. currentmodule:: dwave_networkx.default_sampler
7+
.. currentmodule:: dwave.graphs.default_sampler
88

9-
.. automodule:: dwave_networkx.default_sampler
9+
.. automodule:: dwave.graphs.default_sampler
1010

1111
Functions
1212
=========

0 commit comments

Comments
 (0)