Docs: Make change-log visible in mypy documentation #17742
Conversation
…mypy documentation
for more information, see https://pre-commit.ci
About documentation build errorThe error said |
Helps with python#17742
|
Thanks, let's see if #17747 fixes the build |
|
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.
Don't do this. Instead, decrease the indentation in CHANGELOG.md. Look at https://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.
Looks like it should be auto-replaced across that entire file. Running sed -i 's/^####/###/g' CHANGELOG.md should do what's needed to correct the mistake.
There was a problem hiding this comment.
Thank you very much for your guide!
Tip Pro tip: replace this with |
… header level increase; H2 to H4' warnings in CHANGELOG.md
|
Thank you! |
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