Skip to content
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

Clean up RTD docs #3125

Closed
felixwang9817 opened this issue Aug 23, 2022 · 1 comment
Closed

Clean up RTD docs #3125

felixwang9817 opened this issue Aug 23, 2022 · 1 comment
Labels
kind/bug priority/p2 wontfix This will not be worked on

Comments

@felixwang9817
Copy link
Collaborator

There are several issues with the RTD docs right now:

First, there is no way to confirm whether the RTD docs will build correctly. For example, the v0.23.2 docs did not render correctly, but this issue was not caught until a few days later. It was fixed by #3123, but there should be GH workflow that tests RTD docs during PRs and on master.

Second, the current RTD docs generate a lot of warnings when being built (run make html from feast/sdk/python/docs). There are several different kinds of warnings.

  • For example, there is a WARNING: duplicate object description warning that is probably due to this issue with sphinx/napoleon. I haven't found a simple fix for this yet.
  • There are also a bunch of warnings due to various docstrings in our codebase not conforming to the Google style guide (e.g. something like WARNING: Block quote ends without a blank line; unexpected unindent.). We should (a) fix our docstrings and (b) add a GH workflow that checks for these warnings.
@stale
Copy link

stale bot commented Dec 26, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Dec 26, 2022
@stale stale bot closed this as completed Jan 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug priority/p2 wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant