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

Automatically catch Sphinx errors #8060

Open
ohemorange opened this issue Jun 8, 2020 · 0 comments
Open

Automatically catch Sphinx errors #8060

ohemorange opened this issue Jun 8, 2020 · 0 comments

Comments

@ohemorange
Copy link
Contributor

@ohemorange ohemorange commented Jun 8, 2020

Copied from #7991:

If you look at https://certbot.eff.org/docs/api/certbot.compat.filesystem.html, you'll notice many formatting errors which should be fixed.

That's the bare minimum which I think should be done, but I think we should also see what we can do to avoid these problems from happening in the future. Is there a way we could build the docs in CI and check for these problems? Unfortunately, Sphinx doesn't seem to currently warn about all of the problems here, at least with the warnings it currently has. (Maybe new warnings will appear after others are fixed?)

Finding a way to better catch these problems could be left for future work.

Now that those specific errors are fixed, we should also find a way to automatically check for them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.