Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork3.1k
Docs: Make change-log visible in mypy documentation#17742
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
for more information, seehttps://pre-commit.ci
quinn-sasha commentedSep 6, 2024
About documentation build errorThe error said |
hauntsaninja commentedSep 7, 2024
Thanks, let's see if#17747 fixes the build |
quinn-sasha commentedSep 8, 2024
Next warning was caused by However, it is not strange that there is a increasing header level in change log. |
docs/source/conf.py Outdated
| extensions= ["sphinx.ext.intersphinx","docs.source.html_builder","myst_parser"] | ||
| # To prevent myst-parser from warning header level increases | ||
| suppress_warnings= ["myst.header"] |
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.
Don't do this. Instead, decrease the indentation inCHANGELOG.md. Look athttps://github.com/python/mypy/blob/72c413d/CHANGELOG.md?plain=1#L14 — it uses#### (H4) right after## (H2). So MyST-Parser is correct to flag this. It's a real problem that needs to be fixed rather than ignored.
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.
Looks like it should be auto-replaced across that entire file. Runningsed -i 's/^####/###/g' CHANGELOG.md should do what's needed to correct the mistake.
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.
Thank you very much for your guide!
webknjaz commentedSep 13, 2024
Tip Pro tip: replace this with |
… header level increase; H2 to H4' warnings in CHANGELOG.md
hauntsaninja commentedSep 15, 2024
Thank you! |
Uh oh!
There was an error while loading.Please reload this page.
Resolves#17717
Why
Changes
(Explain how this PR changes mypy.)
This change will make change log visible in mypy documentation.
changelog.mdintmypy/docs/source/to includemypy/CHANGELOG.mdinto mypy documentation.Checklist:
make linkcheckThe test had some warnings, but they were not caused from this pull request change.
Got error
FileNotFoundError: [Errno 2] No such file or directory: 'pre-commit', but I guess it has nothing to do with documentation changes