Skip to content

duplicate of MR !920: add to ocpidoc ability to use both project *and* common dictionaries

Robert Tracy requested to merge 3084-add-project-dictionary-to-ocpidoc into develop

What this MR does / why we need it:

This MR is a duplicate of MR !920 (closed) which cannot be merged directly. The following description is copied from that MR:

Currently ocpidoc uses a single file that contains all the spellings the spellchecker should ignore (tools/opencpi/opencpi_documentation/dictionary.txt). This merge request enhances ocpidoc to use this common dictionary.txt and a project local dictionary.txt. The project local dictionary.txt also sets the spellchecker language.

E.g. "ocpi.comp.sdr/dictionary.txt" might look as below, which would set the spellchecker to UK English and the spellings to ignore in the project as "CIC", "decimator" and "Hanning".

en_GB
CIC
decimator
Hanning

This merge request also fixes ocpidoc enabling proxy worker spec files to be found by the tool and therefore processed.

Steps to complete before submitting MR:

  • I have read Contribution guidelines

  • I have ensured I have a changelog written in the imperative form that is meaningful and accurately summarizes the work done

  • I have added the release notes label if applicable (more information below)

  • I have ensured the workflow labels are up to date and will continue to do so up until this work is merged into develop

  • I have added a category, type, and target release label along with all other labels as need be

  • My branch is up to date with develop. If it is not, then I have ensured my work does not conflict with other work

  • I agree my bugfix MR does not include new features/enhancements

  • I represent that bugfixes have been locally tested against the most recent major.minor release in which the bug exists

  • (REVIEWER ONLY) I have thoroughly gone through the above steps to ensure that they have been followed

Release Notes

N/A

Changelog

  • enh(tools,documentation): modify ocpidoc to use both project and common dictionaries
  • bug(tools,documentation): fix issue with ocpidoc not finding proxy worker spec files

Which issue(s) this MR closes

Closes #3084 (closed)

Edited by Lisa Zahn

Merge request reports