WARNING: 'envvar' reference target not found when running 'sphinx-build' to build docs

[hwhsu1231]

WARNING: 'envvar' reference target not found when running 'sphinx-build' to build docs

[faho]

What this means is that there is no corresponding description for these variables anywhere, so the link doesn't work.

That's fine for these variables.

It won't be shown via cmake because that doesn't turn these warnings on.

You're not doing anything wrong, the docs built fine, just ignore these.

[hwhsu1231]

Hello, @faho

It won't be shown via cmake because that doesn't turn these warnings on.

But even though I modify the content of sphinx-docs target by removing the -q argument and then rebuild with cmake, the warning messages won't show up.

I wonder how does fish-shell's cmake configuration suppress those sphinx-build warning messages?

[hwhsu1231]

Hello, @faho

I think I found the reason. It's because I added the -n argument in sphinx-build command. That's why it would generate those warning messages.

But the reason why I added this -n argument is because I took the following command for reference:

fish-shell/CONTRIBUTING.rst

Line 88 in 15cd74a

sphinx-build -j 8 -b html -n doc_src/ /tmp/fish-doc/

I wonder why fish-shell team added this -n argument in the CONTRIBUTING.rst?

That's fine for these variables.

Also, I wonder why it is fine to ignore these variables?