docs: fix collapse summary truncation - #1647
Open
woutdenolf wants to merge 1 commit into
Open
Conversation
woutdenolf
force-pushed
the
fix_collapse_summary_truncation
branch
from
August 29, 2026 14:13
a4d3e19 to
d94ff9b
Compare
woutdenolf
marked this pull request as ready for review
August 29, 2026 14:18
Contributor
Author
|
FYI @PeterC-DLS the CI of several PRs is broken. This seems to fix it. Not sure why this was not a problem before. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem: doc build fails
CI is currently broken.
make localis failing because the collapse-summary truncationlong_doc()in dev_tools/docs/nxdl.py, currently a blindsingle_line[:max_characters] slice, is cutting doc text mid RST inline-markup.Examples:
Traceback
This produces 28 docutils warnings (fatal under -W) and one Unknown target name error.
Errors regarding "start-string without end-string" due to truncation...
/home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXapm.rst:2517: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXcanSAS.rst:1569: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXmpes.rst:335: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXmpes.rst:434: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXmpes_arpes.rst:690: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXmx.rst:579: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXmx.rst:621: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXstress.rst:1205: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXstress.rst:1494: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXstress.rst:1527: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/applications/NXxeuler.rst:20: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXapm_charge_state_analysis.rst:84: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXatom.rst:247: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXcalibration.rst:172: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXdata.rst:315: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXdata.rst:419: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXdata.rst:522: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXdetector_module.rst:132: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXfit.rst:145: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXfit.rst:203: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/base_classes/NXimage.rst:103: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXapm_paraprobe_nanochem_config.rst:403: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXmicrostructure_ipf.rst:50: ERROR: Unknown target name: "axis". [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXmicrostructure_odf.rst:166: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXmicrostructure_score_config.rst:758: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXregion.rst:119: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXsolid_geometry.rst:57: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXxpcs.rst:392: WARNING: Inline literal start-string without end-string. [docutils] /home/runner/work/definitions/definitions/build/manual/source/classes/contributed_definitions/NXxpcs.rst:486: WARNING: Inline literal start-string without end-string. [docutils]The solution: fix long_doc truncation
This PR strips the partial RST inline-markups.
Examples: