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.

Sign up for GitHub

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

Content checks #174

Closed
szepeviktor opened this issue Nov 13, 2024 · 2 comments · Fixed by #175
Closed

Content checks #174

szepeviktor opened this issue Nov 13, 2024 · 2 comments · Fixed by #175

Comments

@szepeviktor
Copy link
Contributor

Please consider running sphinx-lint and typos.

https://github.com/szepeviktor/byte-level-care/blob/master/.github/workflows/sphinx.yml#L28
https://github.com/szepeviktor/byte-level-care/blob/master/.github/workflows/spelling.yml#L33
@acoulton
Copy link
Contributor

Thanks for the suggestion @szepeviktor - I'm not familiar with those tools (I don't think any of the new/active maintainers are particularly familiar with sphinx & python) but it looks like it could be helpful. If you'd like to propose a PR we'll consider it, that is probably the quickest way to get this looked at.

@stof
Copy link
Member

stof commented Nov 15, 2024

Another tool that can be used is doctor-rst, which is used by the Symfony documentation for instance

@szepeviktor szepeviktor mentioned this issue Nov 15, 2024
Merged
@stof stof closed this as completed in #175 Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create check workflow szepeviktor/docs
3 participants
@acoulton @stof @szepeviktor