Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update rst strings to fix doc build warnings #2288

Merged
merged 3 commits into from Oct 26, 2022
Merged

Update rst strings to fix doc build warnings #2288

merged 3 commits into from Oct 26, 2022

Conversation

smk78
Copy link
Contributor

@smk78 smk78 commented Oct 26, 2022

This PR fixes some more Sphinx warnings generated during the full doc build.

@smk78 smk78 added the Documentation Concerns documentation label Oct 26, 2022
@smk78
Copy link
Contributor Author

smk78 commented Oct 26, 2022

Not fixed by this PR are another ~20 Warnings like these:

D:\SasViewCodeDev\sasmodels\sasmodels\compare.py:docstring of sasmodels.compare.make_engine:: WARNING: more than one target found for cross-reference 'Data1D': sasmodels.bumps_model.Data1D, sasmodels.data.Data1D, sas.qtgui.Plotting.PlotterData.Data1D

D:\SasViewCodeDev\sasview\src\sas\qtgui\Perspectives\Corfunc\IDFCanvas.py:docstring of sas.qtgui.Perspectives.Corfunc.IDFCanvas.IDFCanvas._data:: WARNING: more than one target found for cross-reference 'Data1D': sasmodels.bumps_model.Data1D, sasmodels.data.Data1D, sas.qtgui.Plotting.PlotterData.Data1D

If anyone can demonstrate how to fix these it would be much appreciated!

butlerpd
butlerpd approved these changes Oct 26, 2022
View reviewed changes
Copy link
Member

@butlerpd butlerpd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- glad to see the old sesans docs demoted to being referenced from the fitting doc. No idea about the other errors but those can be another PR

@butlerpd butlerpd merged commit 077cb4f into main Oct 26, 2022
@pkienzle pkienzle deleted the rst_cleanup branch November 4, 2022 20:27
@krzywon krzywon mentioned this pull request Dec 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@butlerpd butlerpd butlerpd approved these changes

Assignees
No one assigned
Labels
Documentation Concerns documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@smk78 @butlerpd