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
Turn warnings into errors during make #153
Conversation
This feels a bit hacky, but afaik this is the only way to add your repos if they are in an org you are not the admin for (short of bugging the repo-admin)
The text implied that the above text was out of date, but it says it's 1.2 in that text. It was a bit confusing so it's best to just delete the references to 1.1
The system in place already exists, it's the github logs section
Borrowing from the more concise migrating page, and removing the "tip" as it creates too many boxes next to each other.
Resolves: #151 (comment) #151 (comment)
gh-app-reg-1.png is still in usage
-W turns warnings into errors, --keep-going will continue building even after the first error
This fixes the warnings we've been getting during make html
Overhaul GitHub app faqs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-W turns warnings into errors
--keep-going will continue building even after the first error/warning
Just to make sure, even if it keeps going, the end result will still be an error, right?
Background for other reviewers: there are warnings in the build that all look worth fixing -- text gets not displayed, etc., so after discussing with Ash, he volunteered to fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i was here, waiting for tests to pass
Fix markdown file's headers
Yes. --keep-going will continue after the first warning so you can catch more than one at a time, but the end result will be a failure both locally and on CircleCI. |
Try it yourself, remove myst-parser and then try to go to /wdl_instructions.html (which is rendered from wdl_instructions.md). See also: https://www.sphinx-doc.org/en/master/usage/markdown.html
replace recommonmark with myst-parser
-W turns warnings into errors, --keep-going will continue building even after the first error
…re/dockstore-documentation into force-warnings-as-errors
Rebase complete, tests are now passing. Huzzah! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for cleaning this up! No errors/warnings in the build any more.
Side note: sphinx-doc/sphinx#9979 (comment) |
If this is merged before docker_instructions.md is turned into a format compatible with rst, it will break develop.
-W
turns warnings into errors--keep-going
will continue building even after the first error/warningThis affects
make html
both locally and on CircleCI.#154 fixes docker_instructions.md and should be merged before this.