Fix sas.models suppression to not accidentally allow private members into sphinx docs#3954
Open
llimeht wants to merge 2 commits into
Open
Fix sas.models suppression to not accidentally allow private members into sphinx docs#3954llimeht wants to merge 2 commits into
llimeht wants to merge 2 commits into
Conversation
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.
Description
Previous changes had allowed private names (variables, functions, methods starting with
_or__) to leak into the sphinx API docs. The result was that they were full of lots of meaningless items that should be hidden from the user. This patch restores the name (in)visibility in the API docs.How Has This Been Tested?
The file that initially drew this to our attention was
dev/sasview-api/sas.qtgui.Perspectives.ParticleEditor.datamodel.html- it came up because the private functions that were included into the docs had irreproducible signatures.As seen in the CI outputs here, that file no longer contains these private names. This also makes the package reproducible, an important step in software assurance.
This patch also removes from very very old compatibility code for Sphinx 2.x.
Review Checklist:
[if using the editor, use
[x]in place of[ ]to check a box]Documentation (check at least one)
Installers
Licensing (untick if necessary)