Messages in this thread | | | Date | Wed, 22 May 2019 13:04:08 -0300 | From | Mauro Carvalho Chehab <> | Subject | Re: [PATCH RFC 0/2] docs: Deal with some Sphinx deprecation warnings |
| |
Em Wed, 22 May 2019 09:45:59 -0600 Jonathan Corbet <corbet@lwn.net> escreveu:
> On Wed, 22 May 2019 15:25:36 +0200 > Markus Heiser <markus.heiser@darmarit.de> wrote: > > > Lets use 1.7 : > > > > - no need for Use_SSI wrapper > > - new log should work with 1.7 [1] --> no need for kernellog.py and > > additional imports, instead include on top of python modules :: > > > > from sphinx.util import logging > > logger = logging.getLogger('kerneldoc') > > I think we're going to have to drag things forward at some point in the > not-too-distant future, but I think I'd rather not do that quite yet. The > cost of supporting older sphinx for a few releases while we warn people is > not all that high. So I think we should: > > - Put in (a future version of) my hacks for now, plus whatever else might > be needed to make 2.0 work right. > > - Fix the fallout with regard to out-of-toctree .rst files so that we can > actually build again with current sphinx. > > - Update Documentation/sphinx/requirements.txt to ask for something a wee > bit more recent than 1.4.9.
You should remember to also update conf.py (with currently points to 1.3):
# If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '1.3'
Also, if you touch there, you should also touch:
./scripts/sphinx-pre-install
The change there won't be as trivial as just changing this line:
$virtenv_dir = "sphinx_1.4";
as the script should now run sphinx-build --version, in order to check if the version is lower than the new minimal version. It probably makes sense to make it grep the version from needs_sphinx at conf.py.
> - Add a warning when building with an older version that (say) 1.7 will > be required as of (say) 5.5.
It probably makes sense to add such check at the pre-install script, and add a:
SPHINXOPTS="-jauto"
somewhere if version is 1.7 or upper.
> > Does this make sense?
It makes sense to me.
Thanks, Mauro
| |