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

[PR #5774/87e4f3b2 backport][3.8] Enable Nitpicky mode in Sphinx docs #5780

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented Jun 7, 2021

This is a backport of PR #5774 as merged into master (87e4f3b).

What do these changes do?

Make sphinx strict about any warnings.

Are there changes in behavior for the user?

No

Related issue number

Resolves #5518

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Resolves #5518

(cherry picked from commit 87e4f3b)
@patchback patchback bot requested a review from asvetlov as a code owner June 7, 2021 15:13
@patchback patchback bot mentioned this pull request Jun 7, 2021
5 tasks
@webknjaz webknjaz enabled auto-merge (squash) June 7, 2021 15:14
@webknjaz webknjaz disabled auto-merge June 7, 2021 15:24
@webknjaz webknjaz merged commit ca7f94b into 3.8 Jun 7, 2021
@webknjaz webknjaz deleted the patchback/backports/3.8/87e4f3b2270f81ee0831005d98d52301e8ecfbe9/pr-5774 branch June 7, 2021 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants