Skip to content

allow ":spelling:ignore" role in "ocpidoc"

Robert Tracy requested to merge 3548-ocpidoc-python-module-versioning into develop

What this MR does / why we need it:

This MR is a duplicate of MR !1019 (closed) containing the suggested merge conflict resolution noted in the comments for that MR.

This merge request increases the minimum version of sphinxcontrib-spelling to v7.7.0 to allow the use of the :spelling:ignore role in ocpidoc.

This role allows the mark-up of some words to not be reported as misspellings, without allowing them elsewhere. For example, author names quoted:

References
~~~~~~~~~~

   1. Pulse Shaping, M. :spelling:ignore:`Lichtman`, <https://pysdr.org/content/pulse_shaping.html>

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(doc,tools): allow :spelling:ignore role in ocpidoc

Which issue(s) this MR closes

Closes #3548 (closed)

Edited by Robert Tracy

Merge request reports