better docs

Author: toumix

README.md

@@ -1,5 +1,5 @@
 
-![snake equation](docs/_static/snake-equation.png)
+![snake equation](https://github.com/discopy/discopy/blob/main/docs/_static/snake-equation.png)
 
 # DisCoPy
 
@@ -35,7 +35,7 @@ DisCoPy began as an implementation of [DisCoCat](https://en.wikipedia.org/wiki/D
 
 Software dependencies between modules go top-to-bottom, left-to-right and [forgetful functors](https://en.wikipedia.org/wiki/Forgetful_functor) between categories go the other way.
 
-[![architecture](docs/api/architecture.png)](https://docs.discopy.org#architecture)
+[![architecture](https://github.com/discopy/discopy/blob/main/docs/api/architecture.png)](https://docs.discopy.org#architecture)
 
 ## Install
 

discopy/quantum/__init__.py

@@ -4,8 +4,7 @@
 DisCoPy quantum modules: channel, circuit, gates, tk and zx.
 """
 
-from discopy.quantum import (
-    circuit, gates, channel, ansatze, zx)
+from discopy.quantum import circuit, gates, channel, ansatze, zx
 
 from discopy.quantum.channel import C, Q, CQ, Channel
 

discopy/quantum/pennylane.py

@@ -3,6 +3,31 @@
 """
 Interface with PennyLane.
 
+Summary
+-------
+
+.. autosummary::
+    :template: class.rst
+    :nosignatures:
+    :toctree:
+
+    PennyLaneCircuit
+
+.. admonition:: Functions
+
+    .. autosummary::
+        :template: function.rst
+        :nosignatures:
+        :toctree:
+
+        tk_op_to_pennylane
+        extract_ops_from_tk
+        get_post_selection_dict
+        to_pennylane
+
+Notes
+-----
+
 If `probabilities` is set to False, the output states of the PennyLane
 circuit will be exactly equivalent to those of the DisCoPy circuit
 (for the same parameters).
@@ -22,15 +47,17 @@
 """
 
 
-from discopy.quantum import Circuit
-from discopy.quantum.gates import Scalar
 from itertools import product
+
 import numpy as np
 import pennylane as qml
 from pytket import OpType
 import sympy
 import torch
 
+from discopy.quantum import Circuit
+from discopy.quantum.gates import Scalar
+
 
 OP_MAP = {
     OpType.X: qml.PauliX,

discopy/quantum/tk.py

@@ -27,8 +27,7 @@
 from unittest.mock import Mock
 
 import pytket as tk
-from pytket.circuit import (Bit, Op, OpType,
-                            Qubit)  # pylint: disable=no-name-in-module
+from pytket.circuit import Bit, Op, OpType, Qubit
 from pytket.utils import probs_from_counts
 
 from discopy import messages

discopy/rigid.py

@@ -34,9 +34,9 @@
 
 >>> from discopy.drawing import Equation
 >>> Equation(left_snake, Id(n), right_snake).draw(
-...     figsize=(4, 2), path='docs/_static/rigid/snake-equation.png')
+...     figsize=(4, 2), path='docs/_static/rigid/typed-snake-equation.png')
 
-.. image:: /_static/rigid/snake-equation.png
+.. image:: /_static/rigid/typed-snake-equation.png
     :align: center
 """
 

docs/_static/rigid/snake-equation.png renamed to docs/_static/rigid/typed-snake-equation.png

@@ -52,7 +52,7 @@ def get_version():
 
 autosummary_generate = True
 
-autodoc_mock_imports = ["pytket", "pennylane", "torch"]
+autodoc_mock_imports = ["pytket", "pennylane", "torch", "sympy"]
 
 autodoc_typehints = "description"
 autodoc_typehints_format = "short"

docs/conf.py

@@ -33,15 +33,20 @@ def get_reqs(filename):
           version=VERSION,
           package_dir={'discopy': 'discopy'},
           packages=find_packages(),
-          description='Distributional Compositional Python',
+          description='The Python toolkit for computing with string diagrams.',
           long_description=open("README.md", "r").read(),
           long_description_content_type="text/markdown",
-          url='https://github.com/discopy/discopy',
+          url='https://discopy.org',
+          project_urls={
+            'Documentation': 'https://docs.discopy.org',
+            'Source': 'https://github.com/discopy/discopy',
+            'Tracker': 'https://github.com/discopy/discopy/issues',
+          },
+          keywords='diagrams category-theory quantum-computing nlp',
           author='Alexis Toumi',
-          author_email='alexis.toumi@cs.ox.ac.uk',
-          download_url='https://github.com/'
-                       'discopy/discopy/archive/'
-                       '{}.tar.gz'.format(VERSION),
+          author_email='alexis@toumi.email',
+          download_url='https://github.com/discopy/discopy/archive/'
+                       f'{VERSION}.tar.gz',
           install_requires=[
               l.strip() for l in open('requirements.txt').readlines()],
           tests_require=TEST_REQS,