The Wayback Machine - https://web.archive.org/web/20201208100857/https://github.com/certbot/certbot/issues/8060
Skip to content

/ certbot

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

Jump to bottom

Automatically catch Sphinx errors #8060

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

Automatically catch Sphinx errors #8060

ohemorange opened this issue Jun 8, 2020 · 2 comments
Labels
area: documentation area: testing good first issue priority: significant

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.
@Farchanter
Copy link

@Farchanter Farchanter commented Sep 16, 2020

hey @ohemorange , could you describe what the formatting issues looked like? I'm just coming on to the project and didn't see the badly formatted page until it was fixed.
@ohemorange
Copy link
Contributor Author

@ohemorange ohemorange commented Sep 16, 2020

Hm, if I remember correctly, it things getting smushed together and maybe some weird bolding? If you look at the PR, you can see the types of changes we had to make: https://github.com/certbot/certbot/pull/8058/files

It's mostly about making sure there are appropriate spaces, and that code (underscores, parens) is appropriately marked with fixed-width text markers:

`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation area: testing good first issue priority: significant
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@ohemorange @Farchanter
You can’t perform that action at this time.