From fd0eaab607bc48e8c15090bc47c442a1b5bbc56e Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Thu, 15 Feb 2024 15:02:34 -0500 Subject: [PATCH 01/13] add sphinxcontrib-spelling to requirements --- requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1a5be0d8..99f3904a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ sphinx sphinx_rtd_theme -sphinx_version_ref \ No newline at end of file +sphinx_version_ref +sphinxcontrib-spelling From 4cf9fa165e09230a799f1c8d6b6ed751ca4e2f39 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Thu, 15 Feb 2024 15:06:30 -0500 Subject: [PATCH 02/13] use sphinx-build -b spelling in the Makefile. make test runs it --- Makefile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Makefile b/Makefile index 3fbd048c..0db589e0 100644 --- a/Makefile +++ b/Makefile @@ -177,9 +177,15 @@ pseudoxml: @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +spelling: + $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling + @echo + @echo "Build finished. The spelling files are in $(BUILDDIR)/spelling." + dos2unix: find . -name "*.txt" | grep -v _build | xargs -IF fromdos F .PHONY: test test: $(MAKE) html ALLSPHINXOPTS="-W --keep-going -n ." + $(MAKE) spelling ALLSPHINXOPTS="-W --keep-going -n ." From 7de5c103a6c470ed6ed1aa6d1d3e4e3538ad9185 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Thu, 15 Feb 2024 15:07:47 -0500 Subject: [PATCH 03/13] update configuration and set it up --- conf.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/conf.py b/conf.py index db37bc0c..89877349 100644 --- a/conf.py +++ b/conf.py @@ -42,8 +42,17 @@ "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinx_version_ref", + "sphinxcontrib.spelling", ] +# spelling + +spelling_lang="en_CA" + +spelling_word_list_filename = ['spelling_wordlist.txt'] + +spelling_show_suggestions=True + # Obtain intersphinx_mapping inventory = "https://gist.githubusercontent.com/qubot/2dd2f7f96e51121061d4/raw/sphinxdoc-inventory.json" response = urlopen(inventory) From 707a8d22e74147cd569965a150985b8fb14fa422 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Thu, 15 Feb 2024 15:08:43 -0500 Subject: [PATCH 04/13] tell sphinxcontrib-spelling which words are correctly spelled --- spelling_wordlist.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 spelling_wordlist.txt diff --git a/spelling_wordlist.txt b/spelling_wordlist.txt new file mode 100644 index 00000000..6b66ce48 --- /dev/null +++ b/spelling_wordlist.txt @@ -0,0 +1,12 @@ +AtoM +Archivematica +Artefactual +Calc +Gearman +config +hostname +subdirectory +Symfony +yml +sfAPPCCache +fonds From ab1412af9850b02c17ec30f39cb53b2c9ffec6ca Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 26 Feb 2024 09:51:10 -0500 Subject: [PATCH 05/13] the spelling_wordlist is now complete --- spelling_wordlist.txt | 465 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 461 insertions(+), 4 deletions(-) diff --git a/spelling_wordlist.txt b/spelling_wordlist.txt index 6b66ce48..3d9c5466 100644 --- a/spelling_wordlist.txt +++ b/spelling_wordlist.txt @@ -1,12 +1,469 @@ -AtoM +accessCondition +accessConditions +accessionNumber +accesstomemory +acquisitionDate +acquisitionType +actorOccupationNotes +actorOccupations +addDonor +Alberton +alternateTitle +alternativeIdentifierNotes +alternativeIdentifiers +alternativeIdentifierTypes +alternativIdentifierLabels +Analytics +analytics +Ansible +apcu +API +api +arArchivesCanadaPlugin +arCasPlugin +archivalHistory Archivematica +archivistNote +arCorcovadoPlugin +arDacsPlugin +arDominionB +arDominionPlugin +arOAIPlugin +arOaiPlugin +arRestApiPlugin +arStorageServicePlugin +Artefact Artefactual +Asao +Asus +AtoM +atomUsers +authorised +autocomplete +autonumerics +autopopulate +barcodes +bc +behavior +behaviors +Bing +bioghist +bo +bolding +boolean +Bootsrap +Bootstrap Calc -Gearman +catalog +center +centered +charset +checkboxes +checkmark +Checksums +cifs +Cinepak +cli +codebase +Codec +color +colors config +consortial +Corcovado +corporateBodyIdentifiers +createdAt +creatorDates +creatorDatesEnd +creatorDatesNotes +creatorDatesStart +crosswalked +css +csv +cURL +customizable +Customizations +Cyrl +dataset +datasets +datepicker +datesOfExistence +datestamp +DDD +dddd +deaccession +deaccessioned +Deaccessions +deacession +descriptionIdentifier +descriptionStatus +dev +digitalobject +digitalObjectPath +digitalObjectURI +discoverable +Dockerfile +donorCity +donorContactPerson +donorCountry +donorEmail +donorFax +donorName +donorNote +donorPostalCode +donorRegion +donorStreetAddress +donorTelephone +draggable +dropdown +Elasticsearch +elasticsearch +endDate +Etsy +eventActorHistories +eventActors +eventDates +eventDescriptions +eventEndDates +eventPlaces +eventStartDates +eventTypes +extentAndMedium +facetstitle +favicon +favor +favored +favorite +FFmpeg +filepath +filepaths +filesize +filesystem +filesystems +findingAids +findingAids +folksonomies +fonds +fpm +Frogstar +frontend +ful +fullTreeviewCollapseClosedButtonText +fullTreeviewCollapseOpenedButtonText +fullwidth +Gearman +generalContext +generalNote +genreAccessPoints +geo +geolocation +Ghostscript +gid +GitHub +globalSearch +glyphs +Gravatar +Gruber +Hashimoto +hollinger +homebrew +Honsberger hostname +htmlpurifier +htop +https +Huffyuv +Hyllier +ICA +ico +ies +iframe +iframes +Imagemagick +img +incrementing +Indeo +informationobject +ini +institutionIdentifier +institutionSearchHoldings +integrations +internalStructures +isad +isLocatedAt +iteratively +javascripts +jdk +jobInfo +jobName +jobStatus +jobUser +jpg +jre +js +js +json +ju +keymap +Kincardine +languageOfDescription +Latn +Laurier +legacyID +legacyId +legalStatus +levelOfDescription +levelOfDetail +linebreak +linebreaks +localhost +locationInformation +locationOfCopies +locationOfOriginals +locationOfOriginals +Logfile +logfile +Logfiles +logfiles +Lucene +macOS +Magrathea +maintenanceNotes +Makefile +materialtype +Matomo +mediatype +memcache +memcached +metadataPrefix +MiB +Munn +mysqld +nameAccessPoints +nd +neighborhoods +Nellymoser +newSlug +nfs +Nginx +nginx +nl +normalizers +oai +objectID +Ok +ok +oldSlug +OPcache +openjdk +organisation +organisational +ote +otherFormsOfName +overlayed +pageview +pageviews +parallelFormsOfName +parentID +parentId +Parsedown +pdf +pdftotext +PDO +Percona +performant +permalink +permalinks +php +phpinfo +physicalCharacteristics +physicalCondition +physicalobject +physicalObjectLocation +physicalObjectName +physicalObjectType +picklist +Pitti +pixellated +placeAccessPoints +png +Postgres +pre +preloaded +prepopulated +processingNotes +processingPriority +processingStatus +publicationsStatus +publicationStatus +px +qtSwordPlugin +qubit +qubitParentSlug +Quicktime +Rackspace +radEdition +radGeneralMaterialDesignation +radNoteAccompanyingMaterial +radNoteAlphaNumericDesignation +radNoteCast +radNoteConservation +radNoteCredits +radNoteEdition +radNotePhysicalDescription +radNotePublisherSeries +radNoteRights +radNoteSignaturesInscriptions +radTitleAttributionsAndConjectures +radTitleContinues +radTitleParallelTitles +radTitleSourceOfTitleProper +radTitleStatementOfResponsibilityNote +radTitleVariationsInTitle +rangeType +Rasterfile +Readline +Reboxing +receivedExtentUnits +recognised +regen +relatedUnitsOfDescription +relationType +relationTypes +reorganisation +repo +reproductionConditions +resourceType +resumptionToken +reusability +revalidating +revisionHistory +rightsholder +rightsholders +RoQ +roundtrip +roundtripping +rsync +rtf +runtime +Ryerson +sanitization +scalability +scopeAndContent +scriptOfDescription +scrollbar +scss +setfacl +setName +setSpec +sfAPCCache +sfAPPCCache +sfDcPlugin +sfEacPlugin +sfEacPlugin +sfEadPlugin +sfIsaarPlugin +sfIsadPlugin +sfIsdfPlugin +sfIsdiahPlugin +sfModsPlugin +sfRadPlugin +sfSkosPlugin +ShareAlike +signifiers +siteSettings +Sorenson +sortable +sourcename +sourceOfAcquisition +sql +src +Staatsbibliothek +standardizedFormsOfName +startDate +staticPages +stopwords +strikethrough +stylesheet +stylesheets +subdirectories subdirectory +subelements +subfonds +subfunctions +subjectAccessPoints +subprocesses +subregion +subrule +Subseries +superset +supervisord Symfony +symfony +symlink +systemd +th +theming +Theora +tokenized +tokenizers +tooltip +tooltips +townarchives +transcoded +treeview +treeviews +Truespeech +typeahead +typeOfEntity +typeOfResource +ufw +uid +un +unassign +uncheck +unchecking +uncomment +unencrypted +unescaped +Unicode +unlink +unlinked +Unported +unreferenced +unselect +unspaced +untrusted +uploader +UTF +Vagrantfile +vagrantfile +validator +vboxsf +vCPUs +virtualization +Virtualizing +VMnc +VMware +Vorbis +watercolors +Wayson +Webalizer +webpack +webpage +webserver +Westwood +whitespace +Wilfrid +www +Xan +Xcode +XSS yml -sfAPPCCache -fonds +yml +Youck +yourSlug +Zaphod +Zend +zoomable +zu From 260d14f90888c7d5eed17c37a3cf36ad4dc43e6f Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 26 Feb 2024 09:55:17 -0500 Subject: [PATCH 06/13] aligning the list items --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 89877349..c8d2b76a 100644 --- a/conf.py +++ b/conf.py @@ -42,7 +42,7 @@ "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinx_version_ref", - "sphinxcontrib.spelling", + "sphinxcontrib.spelling", ] # spelling From d9f8a27c55e8b4e8a8a1958bfb6a6a39b21dce9e Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Mon, 26 Feb 2024 11:44:58 -0500 Subject: [PATCH 07/13] test - maybe we also need to set up the tokenizer? --- conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/conf.py b/conf.py index c8d2b76a..93b1dd46 100644 --- a/conf.py +++ b/conf.py @@ -48,6 +48,7 @@ # spelling spelling_lang="en_CA" +tokenizer_lang="en_CA" spelling_word_list_filename = ['spelling_wordlist.txt'] From 0e3ea8591f47cc40b8a7ecd3aeb997968512e369 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 12:21:30 -0500 Subject: [PATCH 08/13] testing if specifying the spelling_lang is working out... --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 0db589e0..33272959 100644 --- a/Makefile +++ b/Makefile @@ -178,7 +178,7 @@ pseudoxml: @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." spelling: - $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling + $(SPHINXBUILD) -b spelling -D spelling_lang=en_CA $(ALLSPHINXOPTS) $(BUILDDIR)/spelling @echo @echo "Build finished. The spelling files are in $(BUILDDIR)/spelling." @@ -188,4 +188,4 @@ dos2unix: .PHONY: test test: $(MAKE) html ALLSPHINXOPTS="-W --keep-going -n ." - $(MAKE) spelling ALLSPHINXOPTS="-W --keep-going -n ." + $(MAKE) spelling ALLSPHINXOPTS="-W --keep-going ." From 784228aa5a0029540e58df685b1c1ea3e3f544f3 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 13:35:27 -0500 Subject: [PATCH 09/13] test that the locale is installed... --- .github/workflows/test.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6272d3c3..e12c3c01 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -15,6 +15,9 @@ jobs: - name: "Install requirements" run: | pip install -r requirements.txt + locale -a + apt-get install hunspell-en-ca hypen-en-ca + locale -a - name: "Run build test" run: | make test From ed8733c8a550825e7c070f721c798bc899c6b5c5 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 13:38:18 -0500 Subject: [PATCH 10/13] test: add sudo and -y --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e12c3c01..748a31c8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -16,7 +16,7 @@ jobs: run: | pip install -r requirements.txt locale -a - apt-get install hunspell-en-ca hypen-en-ca + sudo apt-get install -y hunspell-en-ca hypen-en-ca locale -a - name: "Run build test" run: | From e4945ddd549f417f3f1770f384079b140c9b7007 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 13:40:41 -0500 Subject: [PATCH 11/13] test: typo --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 748a31c8..70cc814b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -16,7 +16,7 @@ jobs: run: | pip install -r requirements.txt locale -a - sudo apt-get install -y hunspell-en-ca hypen-en-ca + sudo apt-get install -y hunspell-en-ca hyphen-en-ca locale -a - name: "Run build test" run: | From 17dd56241b76b70c1827a54e5c359ac613112f49 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 13:47:03 -0500 Subject: [PATCH 12/13] cleaning up --- .github/workflows/test.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 70cc814b..1d3d40d9 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -15,9 +15,7 @@ jobs: - name: "Install requirements" run: | pip install -r requirements.txt - locale -a sudo apt-get install -y hunspell-en-ca hyphen-en-ca - locale -a - name: "Run build test" run: | make test From eb91b7ce49ea20b601d19b836ef846b9984de307 Mon Sep 17 00:00:00 2001 From: eviau-artefactual Date: Tue, 27 Feb 2024 13:51:51 -0500 Subject: [PATCH 13/13] finish cleaning up - this should still work --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 33272959..65b360c3 100644 --- a/Makefile +++ b/Makefile @@ -178,7 +178,7 @@ pseudoxml: @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." spelling: - $(SPHINXBUILD) -b spelling -D spelling_lang=en_CA $(ALLSPHINXOPTS) $(BUILDDIR)/spelling + $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling @echo @echo "Build finished. The spelling files are in $(BUILDDIR)/spelling."