Add micro version support to needs_sphinx configuration option?

9 views
Skip to first unread message

Tim Graham

unread,
Jan 12, 2016, 6:44:32 PM1/12/16
to sphinx-dev
Hi,

While working on a change for Django's documentation, I found I needed a bug fix in the 1.3.4 release and wanted to set needs_sphinx = '1.3.4', however, as the docs say, "needs_sphinx should be set to a 'major.minor' string. Micro or other versions are not supported (Backwards compatibility is guaranteed between micro releases. There should be no need to require a specific micro version.)".

I didn't track down the particular bug # of the issue that was fixed, but it's that a link like :option:`commandname --traceback` won't work if the space is a newline.

I wonder if anyone else thinks micro version support for needs_sphinx would be useful? If so, I might try implementing.

On a related note, as noted in a GitHub issue [1], the error message if you specific a micro version is confusing and could at least be fixed:

Running Sphinx v1.3.4
Sphinx version error:
This project needs at least Sphinx v1.3.4 and therefore cannot be built with this version.
make: *** [html] Error 1

[1] https://github.com/sphinx-doc/sphinx/issues/527

Thanks!
Tim

Bram Geron

unread,
Jan 13, 2016, 11:42:52 AM1/13/16
to sphinx-dev
I don't have a use case for it, but it does seem useful for some, so I'm for it. 

Cheers, Bram

Komiya Takeshi

unread,
Jan 13, 2016, 11:48:03 AM1/13/16
to sphin...@googlegroups.com
Hi,

I think it is no reason to ignore micro version.
And there is no demerit if we support it.

So I will implement this if no objections.

Thanks,

Takeshi KOMIYA
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-dev+...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

Takayuki Shimizukawa

unread,
Jan 13, 2016, 6:45:31 PM1/13/16
to sphin...@googlegroups.com
No objection from me.
A issue for the feature is created: https://github.com/sphinx-doc/sphinx/issues/2235

Reply all
Reply to author
Forward
0 new messages