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.

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

Fix sphinx warnings from RHEL 7 clean build #15378

Merged
merged 2 commits into from
Feb 18, 2016
Merged

Conversation

NickDraper
Copy link
Contributor

Fix the warnings found on the RHEL clean master build

No issue to close on this, PR only.

Release Notes

Not worth mentioning

To test

check the build output for warnings related to sphinx docs - Text Search for Warning

@NickDraper NickDraper added Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. labels Feb 18, 2016
@NickDraper NickDraper added this to the Release 3.7 milestone Feb 18, 2016
@mantid-builder
Copy link
Collaborator

Thanks for the changes. Here's a few things that we'll use to start the review process:

Main Reviewer

Please comment on the following:

Pull Request
  • Does the title summarize the changes, i.e. it's not the automatically generated one?
  • Is an issue link included/required, e.g. "Fixes #XXXX"? If there is an issue link do the changes look sensible and consistent with issue description?
  • Are there adequate testing instructions?
  • A link to the updated release notes has been provided or no release note updates were necessary?
Code Review
  • Is the code of an acceptable quality?
    • Does the code conform to the coding standards? Is it well structured with small focussed classes/methods/functions?
    • Are there unit/system tests in place? Are the unit tests small and test the class(es) in isolation from one another?
Functional Tests
  • Do changes function as described? Add comments below that describe the tests performed?
    • How do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant documentation been added/updated?
    • Is user-facing documentation written in a user-friendly manner?
    • Has developer documentation been updated if required?

  • Does everything look good? Comment with the ship it emoji but don't merge.

Second Reviewer (@gatekeepers)

  • Have adequate tests, both success & failure cases, been performed?,
  • Has the code been reviewed?,
  • Ready to go? Hit Merge!

@KarlPalmen KarlPalmen self-assigned this Feb 18, 2016
@KarlPalmen
Copy link
Contributor

This is not a fix of issue #13107 , but that is covered by issue #11386 .
I'll just test the documentation as described here.

@KarlPalmen
Copy link
Contributor

I found plenty of warnings, but found that the built document files were OK, especially where changes were made (including links and headings). I do not have Latex so was not able to check the mathematical expression in Point and Space Group.

@KarlPalmen
Copy link
Contributor

:shipit:

FedeMPouzols added a commit that referenced this pull request Feb 18, 2016
Fix sphinx warnings from RHEL 7 clean build
@FedeMPouzols FedeMPouzols merged commit fd66d0a into master Feb 18, 2016
@FedeMPouzols FedeMPouzols deleted the 13107_Doc_warnings branch February 18, 2016 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants