-
Notifications
You must be signed in to change notification settings - Fork 8
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
Configurable extra RST directives and roles #16
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love this! Thanks 👍
Thanks @sobolevn. I've got an afternoon meeting now, but barring any changes being suggested in the interim, I expect to do the merge and release later today. |
This looks like a really clean solution. Nice work!! Once the new release is out, I will definitely put it to use... strip out my blanket Thanks! |
Please give v0.0.11 a shot now, up on PyPI - conda-forge to follow. |
CI passed just fine, with the new version of and config for 👍 🎊 🎉 |
Excellent. Nice to see this being immediately useful, thanks for sharing that real world example. |
Add `mod` as permitted RST role This adds mod to the user list of sphinx roles in the flake8 file. It was being reported by flake8-rst-docstring whcih is being vetted as it is included in the wemake style guide. This was the error begin reported: tests/unit/test_utils.py:1:1: RST304 Unknown interpreted text role "mod". """Test the functions exposed in the :mod:`~ansible_navigator.utils` subpackage.""" ^ Some good info about this is here: peterjc/flake8-rst-docstrings#16 Reviewed-by: Rick Elrod <[email protected]> Reviewed-by: None <None>
Add `mod` as permitted RST role This adds mod to the user list of sphinx roles in the flake8 file. It was being reported by flake8-rst-docstring whcih is being vetted as it is included in the wemake style guide. This was the error begin reported: tests/unit/test_utils.py:1:1: RST304 Unknown interpreted text role "mod". """Test the functions exposed in the :mod:`~ansible_navigator.utils` subpackage.""" ^ Some good info about this is here: peterjc/flake8-rst-docstrings#16 Reviewed-by: Rick Elrod <[email protected]> Reviewed-by: None <None>
This should close #7.
Example tested on a large code base - the following worked on the numpy master branch (they use Sphinx with their own numpydocs extension):
i.e. If they were using flake8, they could put this in their config file: