readthedoc: migrate to build.os + docstring fixes (#529)#535
Merged
Conversation
https://blog.readthedocs.com/use-build-os-config/ Also enable fail_on_warning. Fixes clustershell#529.
Fixes: Engine/Engine.py:docstring of ClusterShell.Engine.Engine.EngineBaseTimer.set_nextfire:3: WARNING: Inline interpreted text or phrase reference start-string without end-string. MsgTree.py:docstring of ClusterShell.MsgTree.MsgTree.__init__:3: WARNING: Inline interpreted text or phrase reference start-string without end-string. NodeSet.py:docstring of ClusterShell.NodeSet.NodeSetBase.__ior__:1: WARNING: Inline substitution_reference start-string without end-string. NodeUtils.py:docstring of ClusterShell.NodeUtils.GroupSource.__init__:5: ERROR: Unknown target name: "groups". Task.py:docstring of ClusterShell.Task.Task:45: WARNING: Block quote ends without a blank line; unexpected unindent. Task.py:docstring of ClusterShell.Task.Task.shell:12: ERROR: Unexpected indentation. Task.py:docstring of ClusterShell.Task.Task.timer:1: WARNING: Inline interpreted text or phrase reference start-string without end-string. Task.py:docstring of ClusterShell.Task.Task.timer:7: WARNING: Inline interpreted text or phrase reference start-string without end-string. Task.py:docstring of ClusterShell.Task.Task.timer:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. Task.py:docstring of ClusterShell.Task.Task.timer:16: WARNING: Inline interpreted text or phrase reference start-string without end-string. Worker/Exec.py:docstring of ClusterShell.Worker.Exec.ExecClient.__init__:1: WARNING: Inline interpreted text or phrase reference start-string without end-string. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker:8: ERROR: Unexpected indentation. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker.read:8: WARNING: Definition list ends without a blank line; unexpected unindent. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker.set_reader:7: ERROR: Unexpected indentation. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker.set_reader:8: WARNING: Block quote ends without a blank line; unexpected unindent. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker.set_writer:7: ERROR: Unexpected indentation. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.StreamWorker.set_writer:8: WARNING: Block quote ends without a blank line; unexpected unindent. Worker/Worker.py:docstring of ClusterShell.Worker.Worker.Worker.read:8: WARNING: Definition list ends without a blank line; unexpected unindent. Worker/Pdsh.py:docstring of ClusterShell.Worker.Pdsh.PdshClient.__init__:1: WARNING: Inline interpreted text or phrase reference start-string without end-string. Worker/Popen.py:docstring of ClusterShell.Worker.Popen.PopenClient.__init__:11: ERROR: Unexpected indentation. Worker/Rsh.py:docstring of ClusterShell.Worker.Rsh.RshClient.__init__:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.
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
1 participant
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.
See: https://blog.readthedocs.com/use-build-os-config/
Also
enable fail_on_warning.