Add sphinx-lint session to noxfile

[rffontenelle]

See #1166

This runs sphinx-lint in the docs together with HTML build and linkcheck. It accepts one or more path as positional argument, so e.g. one may specify the path of a translation file instead of using the source reST files from "source" directory.

I was going to add sphinx-lint package to requirements.txt and pip-install from that file, but this unnecessarily added dependencies and increased install time.

Running without posargs:

$ python -m nox -s sphinx_lint
nox > Running session sphinx_lint
nox > Creating virtual environment (virtualenv) using python in .nox/sphinx_lint
nox > python -m pip install sphinx-lint
nox > sphinx-lint source
source/glossary.rst:294: OMG TABS!!!1 (horipython -m nox -s sphinx_lintzontal-tab)
source/guides/creating-command-line-tools.rst:105: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:106: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:107: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:126: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:127: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:148: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:149: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:150: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:151: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:152: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:153: OMG TABS!!!1 (horizontal-tab)
source/guides/creating-command-line-tools.rst:163: OMG TABS!!!1 (horizontal-tab)
nox > Command sphinx-lint source failed with exit code 1
nox > Session sphinx_lint failed.

Running with a posargs as the filepath "messages.po", the Brazilian Portuguese translation obtained from translation/source branch:

$ python -m nox -s sphinx_lint -- messages.po 
nox > Running session sphinx_lint
nox > Creating virtual environment (virtualenv) using python in .nox/sphinx_lint
nox > python -m pip install sphinx-lint==1.0.0
nox > sphinx-lint messages.po
No problems found.
nox > Session sphinx_lint was successful.

---

📚 Documentation preview 📚: https://python-packaging-user-guide--1800.org.readthedocs.build/en/1800/

[chrysle]

Thanks for your contribution! But probably it will be sufficient to add sphinx-lint to CI (#1786)?

[webknjaz]

Thanks!

[webknjaz]

Thanks for your contribution! But probably it will be sufficient to add sphinx-lint to CI (#1786)?

I like both solutions. The important bit is the ability to invoke it locally.

@rffontenelle WDYT? Should we go for the other PR?

[rffontenelle]

I'm fine with it.

Although I wonder if it uses problem-matcher annotations and if not if it would feasible. Personally I find annotations very handy on GitHub Actions run log

[ncoghlan]

@rffontenelle @webknjaz I was clearing out the approved-but-not-merged PRs, and noticed this one was still lingering, but now with conflicts. Should we just close it, or is it worth resurrecting?

[webknjaz]

@ncoghlan I seem to recall a similar/related PR by @hugovk but don't remember the context anymore. We should merge this provided https://docs.zizmor.sh/audits/#template-injection is addressed.

[webknjaz]

This should be rendered on the bash layer to avoid the template injection problems:

Suggested change

	run: nox -s sphinx_lint -- locales/${{ matrix.language }}/LC_MESSAGES/messages.po
	run: nox -s sphinx_lint -- locales/${LANGUAGE}/LC_MESSAGES/messages.po

[hugovk]

@ncoghlan I seem to recall a similar/related PR by @hugovk but don't remember the context anymore.

#1786 (comment)