Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add rstcheck to CI #3624
Looks like currently the tool isn't very mature, we can't specify what errors to ignore (there are some very specific cases that are false positives). Anyway, I think this could be a good improvement to merge in the future :). I'm going to see if I can collaborate on rstcheck.
referenced this pull request
Feb 17, 2018
Seems they are not that many:
I think we can fix them in this PR also, right?
I think this is a really good improve to have automatically triggered in our PRs.
ignore_messages, I'd say that it's good enough for now. Having this and ignore just 2 messages it too much better than ignoring everything as we were doing before this PR.
Optimization: is it possible to trigger this
docs-lint env _only when there are changes in the
I'm not sure if that would be possible, maybe a setting on travis? Since the linting is very quick, the heavy stuff comes from travis and installing the deps p:
This looks good and very close to merge, from my point of view.
I'm marking this as "Request changes" because there are some internal links that will be broken with these modifications.
We will need to be sure that each link that we modify still works before merging. You can check that by building the documentation by yourself in your local instance:
cd docs make html firefox _build/htmls/index.html
Great changes. We should write a blog post about this, so that other folks in the community might be able to benefit from the knowledge here.
/cc @davidfischer, can we add that to our editorial calendar, and I can help write it up w/ Santos' review perhaps.