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

Extend check functionality of conf.py option needs_sphinx #2235

Closed
fkromer opened this issue Jan 13, 2016 · 4 comments
Closed

Extend check functionality of conf.py option needs_sphinx #2235

fkromer opened this issue Jan 13, 2016 · 4 comments
Assignees
Milestone

Comments

@fkromer
Copy link

fkromer commented Jan 13, 2016

The option needs_sphinx in conf.py does support the major and the minor version number e.g. needs_sphinx = '1.3' for Sphinx v1.3.3, Sphinx v1.3.4, and so on (tested with Sphinx v1.3.4). In some situations (needs v1.3.4 and shall warn when v1.3.3 is used) it would be helpful to have the whole Sphinx version checked.

@tk0miya
Copy link
Member

tk0miya commented Jan 13, 2016

It was rejected at #527. But I think it is no reason to ignore micro version.
There is no demerit if we support it.

So I will implement this if no objection.

@tk0miya tk0miya self-assigned this Jan 13, 2016
@fkromer
Copy link
Author

fkromer commented Jan 13, 2016

I posted the issue because i came across an integration issue of my generated .html files (without issue on localhost) which are hosted on readthedocs.org. My sphinx-doc environment requires Sphinx v1.3.4 which i can guarantee on my local environment. However it seems like readthedocs.org uses another Sphinx v1.3.x version as default (conf.py: needs_sphinx = 1.3). The .html files where build but without supporting a feature of my (local) website. If the option needs_sphinx in conf.py would specify the whole version the website build of readthedocs.org should have failed because conf.py is used by readthedocs.org for building.

Hint: I was able to force readthedocs.org to use Sphinx v1.3.4 by specifying to build from virtualenv and by specifying the corresponding requirements.txt file in the readthedocs.org project settings (project/advanced settings/"Install your project inside a virtualenv using setup.py install" & path from project root to pip requirements file).

@tk0miya
Copy link
Member

tk0miya commented Jan 21, 2016

Fixed at 04a8c26.
Thank you for suggestion

(but this will be introduced in next major release...)

@tk0miya tk0miya added this to the 1.4 milestone Jan 21, 2016
@fkromer
Copy link
Author

fkromer commented Jan 21, 2016

Great, thank you!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants