Release version 0.4.3

Co-authored-by: Dimitri Kartsaklis <[email protected]>
CQCL · Sep 2, 2024 · 8b80d2c · 8b80d2c
1 parent e012aa9
commit 8b80d2c
Show file tree

Hide file tree

Showing 110 changed files with 24 additions and 15,514 deletions.
diff --git a/.github/workflows/build-docs b/.github/workflows/build-docs
diff --git a/.github/workflows/build_test.yml b/.github/workflows/build_test.yml
@@ -12,7 +12,6 @@ on:
 env:
   SRC_DIR: lambeq
   TEST_DIR: tests
-  DOCS_DIR: docs
 
 jobs:
   lint:
@@ -82,22 +81,6 @@ jobs:
         --doctest-modules
         --durations=50
         --ignore=${{ env.TEST_DIR }}/text2diagram/test_depccg_parser.py
-        --ignore=${{ env.DOCS_DIR }}/extract_code_cells.py
-    - name: Preparation for notebook testing
-      run: pip install nbmake
-    - name: Test example notebooks
-      env:
-        TEST_NOTEBOOKS: 1
-      run: >
-        pytest --nbmake ${{ env.DOCS_DIR }}/examples/
-        --nbmake-timeout=60
-    - name: Test tutorial notebooks
-      env:
-        TEST_NOTEBOOKS: 1
-      run: >
-        pytest --nbmake ${{ env.DOCS_DIR }}/tutorials/
-        --nbmake-timeout=60
-        --ignore ${{ env.DOCS_DIR }}/tutorials/code
     - name: Coverage report
       run: coverage report -m
   type_check:

diff --git a/.github/workflows/clear-target-files b/.github/workflows/clear-target-files
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@ htmlcov/
 # ignore the built documentation
 docs/_*
 !docs/_static/
+!docs/_templates/
 docs/puml/img
 
 # ignore runs and related artifacts

diff --git a/.gitmodules b/.gitmodules
@@ -1,4 +0,0 @@
-[submodule "docs/quantinuum-sphinx"]
-	path = docs/quantinuum-sphinx
-	url = https://github.com/CQCL/quantinuum-sphinx.git
-	branch = dist

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # lambeq
 
-[![lambeq logo](https://cqcl.github.io/lambeq/_static/lambeq_logo.png)](//cqcl.github.io/lambeq)
+[![lambeq logo](https://cqcl.github.io/lambeq-docs/_static/lambeq_logo.png)](//cqcl.github.io/lambeq-docs)
 
 ![Build status](https://github.com/CQCL/lambeq/actions/workflows/build_test.yml/badge.svg)
 [![License](https://img.shields.io/github/license/CQCL/lambeq)](LICENSE)
@@ -12,16 +12,11 @@
 
 lambeq is a toolkit for quantum natural language processing (QNLP).
 
-- Documentation: https://cqcl.github.io/lambeq/
+- Documentation: https://cqcl.github.io/lambeq-docs/
 - User support: <[email protected]>
-- Contributions: Please read [our guide](https://cqcl.github.io/lambeq/CONTRIBUTING.html).
+- Contributions: Please read [our guide](https://cqcl.github.io/lambeq-docs/CONTRIBUTING.html).
 - If you want to subscribe to lambeq's mailing list, let us know by sending an email to <[email protected]>.
 
----
-**Note:** Please do not try to read the documentation directly from the preview provided in the [repository](https://github.com/CQCL/lambeq/tree/main/docs), since some of the pages will not be rendered properly.
-
----
-
 ## Getting started
 
 ### Prerequisites
@@ -31,13 +26,15 @@ lambeq is a toolkit for quantum natural language processing (QNLP).
 ### Installation
 
 lambeq can be installed with the command:
+
 ```bash
 pip install lambeq
 ```
 
 The default installation of lambeq includes Bobcat parser, a state-of-the-art statistical parser (see [related paper](https://arxiv.org/abs/2109.10044)) fully integrated with the toolkit.
 
 To install lambeq with optional dependencies for extra features, run:
+
 ```bash
 pip install lambeq[extras]
 ```
@@ -57,12 +54,11 @@ python contrib/download_depccg_model.py
 
 ## Usage
 
-The [docs/examples](//github.com/CQCL/lambeq/tree/main/docs/examples)
-directory contains notebooks demonstrating usage of the various tools in
-lambeq.
+The [docs/examples](//github.com/CQCL/lambeq-docs/tree/main/docs/examples)
+directory in lambeq's [documentation repository](https://github.com/CQCL/lambeq-docs) contains notebooks demonstrating usage of the various tools in lambeq.
 
 Example - parsing a sentence into a diagram (see
-[docs/examples/ccg2discocat.ipynb](//github.com/CQCL/lambeq/blob/main/docs/examples/ccg2discocat.ipynb)):
+[docs/examples/parser.ipynb](//github.com/CQCL/lambeq-docs/blob/main/docs/examples/parser.ipynb)):
 
 ```python
 from lambeq import BobcatParser
@@ -75,28 +71,14 @@ diagram.draw()
 ## Testing
 
 Run all tests with the command:
+
 ```bash
 pytest
 ```
 
-Note: if you have installed in a virtual environment, remember to
+Note: if you have installed lambeq in a virtual environment, remember to
 install pytest in the same environment using pip.
 
-## Building documentation
-
-To build the documentation, first install the required dependencies:
-```bash
-pip install -r docs/requirements.txt
-```
-then run the commands:
-
-```bash
-cd docs
-make clean
-make html
-```
-the docs will be under `docs/_build`.
-
 ## License
 
 Distributed under the Apache 2.0 license. See [`LICENSE`](LICENSE) for

diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_static/css/table-wrap.css b/docs/_static/css/table-wrap.css
diff --git a/docs/_static/images/CQ-logo.png b/docs/_static/images/CQ-logo.png
diff --git a/docs/_static/images/Quantinuum_logo.png b/docs/_static/images/Quantinuum_logo.png
diff --git a/docs/_static/images/ccg-diagram.png b/docs/_static/images/ccg-diagram.png
diff --git a/docs/_static/images/ccgbank.png b/docs/_static/images/ccgbank.png
diff --git a/docs/_static/images/comm-diagram.png b/docs/_static/images/comm-diagram.png
diff --git a/docs/_static/images/favicon.ico b/docs/_static/images/favicon.ico
diff --git a/docs/_static/images/lambeq_logo.png b/docs/_static/images/lambeq_logo.png
diff --git a/docs/_static/images/linear.png b/docs/_static/images/linear.png
diff --git a/docs/_static/images/pipeline.png b/docs/_static/images/pipeline.png
diff --git a/docs/_static/images/pregroups.png b/docs/_static/images/pregroups.png
diff --git a/docs/_static/images/snake-2.png b/docs/_static/images/snake-2.png
diff --git a/docs/_static/images/snake.png b/docs/_static/images/snake.png
diff --git a/docs/_static/images/string_diagram.png b/docs/_static/images/string_diagram.png
diff --git a/docs/_static/images/string_diagram_with_swaps.png b/docs/_static/images/string_diagram_with_swaps.png
diff --git a/docs/_static/images/use_cases.png b/docs/_static/images/use_cases.png
diff --git a/docs/_static/nav-config.js b/docs/_static/nav-config.js
diff --git a/docs/advanced.rst b/docs/advanced.rst