Add newline to prevent sphinx compilation warning #21
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
Otherwise, when I run `make clean && make html` in the docs directory, I get the
warning:
eFFORT/eFFORT/hybrid/hybrid_model.py:docstring of eFFORT.hybrid.hybrid_model.Hybrid.generate_hybrid_weights:10: WARNING: Definition list ends without a blank line; unexpected unindent.
I compared the generated html and it seems this doesn't change anything, so
despite the warning sphinx was able to handle the missing blank line. Still,
nicer to be warning free.
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.
Otherwise, when I run
make clean && make htmlin thedocsdirectory, I get the warning:I compared the generated html and it seems this doesn't change anything, so despite the warning sphinx was able to handle the missing blank line. Still, nicer to be warning free.