Skip to content
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

Fix most warnings in Sphinx build #2124

Merged
merged 3 commits into from
May 13, 2022
Merged

Conversation

jeanas
Copy link
Contributor

@jeanas jeanas commented Apr 29, 2022

Note that some invalid references are simply removed because the
lexers are all in the same section, so the link is already easy to
find and there is no need to repeat it over and over.

Note that some invalid references are simply removed because the
lexers are all in the same section, so the link is already easy to
find and there is no need to repeat it over and over.
@jeanas
Copy link
Contributor Author

jeanas commented Apr 29, 2022

@birkenfeld A question for a Sphinx expert :-)

The remaining warning is

/home/jean/repos/pygments/doc/faq.rst:15: WARNING: unknown document: languages

This comes from

* a wide range of common :doc:`languages and markup formats <languages>` is supported

Since 64e8e05, the languages document comes from an HTML template, included with html_additional_pages. Is there a way to reference it?

@birkenfeld
Copy link
Member

Yeah that's a bit sad - the workaround is to keep languages.rst around, not connected to a toctree, and put :orphan: into it to shut up the warning about the latter.

@jeanas
Copy link
Contributor Author

jeanas commented May 12, 2022

Thanks for the tip! There should be no warnings at all now.

@jeanas
Copy link
Contributor Author

jeanas commented May 12, 2022

I move to merge this, since the fixes are rather trivial.

@birkenfeld birkenfeld merged commit c4dcc93 into pygments:master May 13, 2022
@birkenfeld
Copy link
Member

Indeed!

@jeanas jeanas deleted the doc-warnings branch May 13, 2022 05:32
d-torrance added a commit to d-torrance/M2 that referenced this pull request May 16, 2022
Apparently fixes a warning in a Sphinx build.  See
pygments/pygments#2124.

[ci skip]
@jeanas jeanas added changelog-update Items which need to get mentioned in the changelog and removed changelog-update Items which need to get mentioned in the changelog labels May 20, 2022
@jeanas jeanas added this to the 2.13.0 milestone May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants