Apply spell check to tutorials (#64)

* apply spell check to tutorials

* add a package

* treat spelling warning as error

* add pylintdict as word list of tutorial check

* update spelling word list

* add a word

* change var_form to ansatz

* simplify

* rename all var_form to ansatz

* add a word

* add words

* fix doc spelling

Co-authored-by: Manoel Marques <[email protected]>

Author: t-imamichi

Makefile

@@ -60,6 +60,7 @@ test_ci:
 
 spell:
 	pylint -rn --disable=all --enable=spelling --spelling-dict=en_US --spelling-private-dict-file=.pylintdict qiskit_optimization test tools
+	make -C docs spell SPHINXOPTS=$(SPHINXOPTS)
 
 copyright:
 	python tools/check_copyright.py

docs/Makefile

@@ -20,6 +20,9 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+spell:
+	@$(SPHINXBUILD) -W -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docs/conf.py

@@ -119,6 +119,8 @@
     '_static/5_ADMM.png',
 }
 
+spelling_word_list_filename = ['spelling_wordlist.txt', '../.pylintdict']
+
 # -----------------------------------------------------------------------------
 # Autosummary
 # -----------------------------------------------------------------------------

docs/spelling_wordlist.txt

@@ -0,0 +1,92 @@
+ADMMOptimizationResult
+ADMMOptimizer
+ADMMParameters
+ADMMState
+Aer
+Applegate
+BaseAggregator
+Bixby
+CVaR
+Chvátal
+CobylaOptimizer
+CplexOptimizer
+ExactCover
+Farhi
+GoemansWilliamsonOptimizationResult
+GoemansWilliamsonOptimizer
+Goldstone
+GraphOptimizationApplication
+GraphPartition
+GroverOptimizationResult
+GroverOptimizer
+Gutmann
+InequalityToEquality
+IntegerToBinary
+IntermediateResult
+LinearConstraint
+LinearEqualityToPenalty
+LinearExpression
+macOS
+MeanAggregator
+MinimumEigenOptimizationResult
+MinimumEigenOptimizer
+MultiStartOptimizer
+Neven
+NetworkX
+NumberPartition
+Optimality
+OptimizationAlgorithm
+OptimizationApplication
+OptimizationResult
+OptimizationResultStatus
+QiskitOptimizationError
+QuadraticConstraint
+QuadraticExpression
+QuadraticObjective
+QuadraticProgram
+QuadraticProgramConverter
+QuadraticProgramElement
+QuadraticProgramToQubo
+RecursiveMinimumEigenOptimizationResult
+RecursiveMinimumEigenOptimizer
+Rz
+SetPacking
+SlsqpOptimizationResult
+SlsqpOptimizer
+SolutionSample
+StableSet
+Travelling
+Troyer
+VehicleRouting
+VertexCover
+WarmStartQAOAFactory
+WarmStartQAOAOptimizer
+Wecker
+Zemlin
+adaptively
+arXiv
+arxiv
+behaviour
+combinatorial
+deterministically
+doi
+dok
+entangler
+exponentiated
+fmin
+multiset
+optimality
+param
+probabilistically
+rtype
+slsqp
+smoothen
+subcollection
+subproblem
+summands
+traceback
+tradeoff
+tsplib
+undirected
+wavefunction
+zsh

requirements-dev.txt

@@ -11,6 +11,7 @@ Sphinx>=1.8.3,!=3.1.0,<4
 sphinx-panels
 sphinx-gallery
 sphinx-autodoc-typehints
+sphinxcontrib-spelling
 jupyter-sphinx
 discover
 qiskit-aer