-
Notifications
You must be signed in to change notification settings - Fork 144
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
Itemize paper references again. #209
Conversation
I noticed that the autodoc tox step is not called for PRs. To enable it, I had to remove the build.py call from autodoc.py. But this actually brings the test more in line with the other tox tests, since they all assume that the planner is already built. |
I think not calling autodoc on each PR was by design: we certainly do not want to update the wiki before a PR is merged, and as a dry run, I don't really see the point because there is no way to see what the changes would look like in the wiki. It's also no "test" that can fail in a meaningful way, is it? I think running it on PRs is unnecessary work that just makes the actions take longer, but I don't feel too strongly about it. The change to install txt2tags with pip rather than us providing a version in |
The autodoc tox test runs in a fraction of a second. And it failed in a meaningful way for me while working on this issue, so I think it's good to run the test. If the binary is missing during an autodoc.py call, we automatically get "Could not find build 'release' at /home/jendrik/projects/Downward/downward/builds/release/bin. Please run './build.py release'." from the driver already. For the case where txt2tags is missing, I added an error message. I wouldn't add the txt2tags dependency to the wiki dev instructions since tox installs it transparently. Good to merge? |
Fine with me. I'd still add the dependency to the wiki because the tox installation doesn't help when using the script directly. |
This requires a new txt2tags version, which we install via pip rather than bundling it.