Cleanup docs build #501
Merged
Cleanup docs build #501
Conversation
This file contains 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
Signed-off-by: fliiiix <hi@l33t.name>
This removes the following error from the doc build client.py:docstring of pylxd.client.Client.events:21: ERROR: Unknown interpreted text role "param". Signed-off-by: fliiiix <hi@l33t.name>
Fixes these two warnings: UserWarning: Usage of dash-separated 'author-email' will not be supported in future versions. Please use the underscore name 'author_email' instead UserWarning: Usage of dash-separated 'home-page' will not be supported in future versions. Please use the underscore name 'home_page' instead Signed-off-by: fliiiix <hi@l33t.name>
Fixes these 2 warnings: storage_pool.py:docstring of pylxd.models.storage_pool.StoragePool.create:11: WARNING: Definition list ends without a blank line; unexpected unindent. storage_pool.py:docstring of pylxd.models.storage_pool.StoragePool.create:14: WARNING: Definition list ends without a blank line; unexpected unindent. Signed-off-by: fliiiix <hi@l33t.name>
A code-block needs to be followed by a black line. ERROR: Error in "code-block" directive: maximum 1 argument(s) allowed, 13 supplied. Signed-off-by: fliiiix <hi@l33t.name>
Signed-off-by: fliiiix <hi@l33t.name>
Codecov Report
@@ Coverage Diff @@
## master #501 +/- ##
=======================================
Coverage 97.07% 97.07%
=======================================
Files 56 56
Lines 4101 4101
=======================================
Hits 3981 3981
Misses 120 120
Continue to review full report at Codecov.
|
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.
I ran
tox -e docand fixed all warnings and issues i found.