Some sphinx documentation formatting fixes #66
Merged
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
The code formatting for the example in the docs for ``get_input_file_names_from_dict()`` was broken, so I fixed that, by adding an additional code-block environment. Also I changed one other example for consistency, so that the text "Example" is now the key/label of an RST definition list.
Otherwise, sphinx formats everything right but gives a warning. Also, my edtior added a newline at the end of basf2_helper.rst.
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 worked on removing some of the sphinx warnings that I mention in issue #64. Most importantly, the example for
get_input_file_names_from_dict()by @welschma was not rendered as a code block.I haven't yet managed to remove all warnings, one type of warning still remains:
And the same for some other tasks with the
output()method that are automatically included. But I couldn't come up with a quick fix and the docs for theCdstDataTasketc. look nice despite the warning, so I think I should just merge what I have so far and get on with more important issues.