Skip to content

Commit 176c34b

Browse files
committed
refactor docs
1 parent 95cbadc commit 176c34b

33 files changed

+202
-1312
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*.pyc
1414
*.nav
1515
docs/_build/*
16-
docs/api/*
16+
docs/_api/*
1717
*/__pycache__/*
1818
*.egg-info
1919
build/*

discopy.bib

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@article{DelpeuchVicary22,
2+
title = {Normalization for Planar String Diagrams and a Quadratic Equivalence Algorithm},
3+
author = {Delpeuch, Antonin and Vicary, Jamie},
4+
date = {2022},
5+
journaltitle = {Logical Methods in Computer Science},
6+
shortjournal = {Log. Methods Comput. Sci.},
7+
volume = {18},
8+
number = {1},
9+
doi = {10.46298/lmcs-18(1:10)2022}
10+
}
11+
12+
@article{Selinger10,
13+
title = {A {{Survey}} of {{Graphical Languages}} for {{Monoidal Categories}}},
14+
author = {Selinger, P.},
15+
date = {2010},
16+
journaltitle = {New Structures for Physics},
17+
pages = {289--355},
18+
doi = {10.1007/978-3-642-12821-9_4},
19+
keywords = {18D10,Mathematics - Category Theory},
20+
file = {/Users/alexis.toumi/WORK/Zotero/storage/3HSB2T6D/Selinger - 2010 - A survey of graphical languages for monoidal categ.pdf;/Users/alexis.toumi/WORK/Zotero/storage/VGWGBWBQ/0908.html}
21+
}

discopy/__init__.py

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# -*- coding: utf-8 -*-
22

3-
"""
4-
The library is organised in five groups of modules:
5-
syntax, semantics, quantum, grammar and other.
6-
"""
3+
""" DisCoPy: the Python toolkit for computing with string diagrams. """
74

85
from discopy import (
96
cat,

discopy/monoidal.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@ def interchange(self, i: int, j: int, left=False) -> Diagram:
721721
def normalize(self, left=False) -> Iterator[Diagram]:
722722
"""
723723
Implements normalisation of boundary-connected diagrams,
724-
see arXiv:1804.07832.
724+
see :cite:t:`DelpeuchVicary22`.
725725
726726
Parameters:
727727
left : Passed to :meth:`Diagram.interchange`.

discopy/quantum/__init__.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
DisCoPy quantum modules: channel, circuit, gates, tk and zx.
55
"""
66

7-
from discopy.quantum import circuit, gates, channel, ansatze, optics, zx
7+
from discopy.quantum import (
8+
circuit, gates, channel, ansatze, zx)
89

910
from discopy.quantum.channel import C, Q, CQ, Channel
1011

discopy/quantum/gates.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@
1111
:nosignatures:
1212
:toctree:
1313
14-
AntiConjugate
15-
Anti2QubitConjugate
1614
SelfConjugate
15+
AntiConjugate
1716
Discard
1817
MixedState
1918
Measure

0 commit comments

Comments
 (0)