-
Notifications
You must be signed in to change notification settings - Fork 31
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
Sphinx Build is throwing many warnings #178
Comments
@maneelusf @devendragovil what is the udpate on this issue? |
@maneelusf @devendragovil what is the update on this? |
A major update on this issue: UpdateThere are over 250 warnings that are being thrown during the docs build process mostly because the function/method docstrings haven't been written to be compliant with numpydoc. I have been trying to resolve these, but in a lot of cases I think the original method creator can help resolve the issues better. Further IssuesDue to the docstring parsing warnings, the docs generated by sphinx are not complete or correct. SolutionI think two steps are needed:
|
I am working on amending the pre-commit file and the CI/CD workflow to incorporate docstring checks. |
We have validation since #297, but I think the checks do not fail for warnings |
@ffl096 If I understand it correctly, the check has been placed as the part of the sphinx build process by specifying numpydoc validation in the conf.py file read by Sphinx. I think we may want to add the check in the CI/CD workflow explicitly. |
Why? It is part of the CI/CD workflow this way as well. Not sure why we should spread doc-related validations across different places instead of everything in sphinx. |
I would argue that this isn't a doc related validation, but more so related to codebase i.e. the docstrings format. However, the more important goal should be to fail a CI/CD workflow so as to incentivize correct docstring formatting something akin to compliance with PEP8. |
… and enforcing compliance with Numpy Doc Validation. This helps with issue pyt-team#178.
…ations. Some functions were skipped, see pyt-team#326 This resolves pyt-team#178
What?
Sphinx Build is throwing a multitude of warnings. Example:
Why?
The warnings right now might turn acute later on. Need to see what is going on.
The text was updated successfully, but these errors were encountered: