Large reorganisation of documentation, along with multiple fixes of internal references

Author: gchqdev227

.cspell/library_terms.txt

@@ -19,6 +19,7 @@ bmatrix
 booktitle
 bysource
 cmap
+dispname
 dollarmath
 dtype
 dtypes
@@ -37,11 +38,13 @@ intersphinx
 isort
 issubdtype
 jacrev
-JAX's
+jax
+jaxlib
 jaxopt
 jumanjihouse
 linalg
 linkcheck
+literalinclude
 lstsq
 mathbb
 mathbf
@@ -63,6 +66,7 @@ OSQP
 params_ineq
 pinv
 pvalue
+pybtex
 pydocstyle
 pylint
 pylintrc
@@ -84,6 +88,7 @@ setuptools
 sklearn
 softplus
 sphinxcontrib
+sphobjinv
 texttt
 toctree
 tomli
@@ -92,7 +97,9 @@ triu
 typehints
 undoc
 unflatten
+unsrt
 viewcode
 vmap
+writebytes
 xlabel
 ylabel

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+.scannerwork
 
 # Translations
 *.mo
@@ -70,6 +71,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+*.inv
 
 # PyBuilder
 .pybuilder/

.pre-commit-config.yaml

@@ -86,7 +86,8 @@ repos:
         exclude: |
           (?x)^(
             tests|
-            documentation/source/conf.py
+            documentation/source/conf.py|
+            documentation/source/snippets
           )
   - repo: https://github.com/streetsidesoftware/cspell-cli
     rev: v8.3.0
@@ -127,3 +128,4 @@ repos:
           - "-rn" # Only display messages
           - "-sn" # Don't display the score
           - "--rcfile=.pylintrc" # pylint configuration file
+        exclude: "documentation/source/snippets"

.pylintrc

@@ -424,6 +424,7 @@ confidence=HIGH,
 disable=too-many-lines,
         too-many-arguments,
         too-many-instance-attributes,
+        import-error,