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

Latest sphinx clobbers pinned sphinx version (which breaks autosummary) #7833

Closed
chummels opened this issue Jan 14, 2021 · 4 comments
Closed
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@chummels
Copy link

Details

Starting about 6 months ago, the autosummary functionality in our docs spontaneously stopped working without any changes on our end, and it left us with no API docs (see: https://trident.readthedocs.io/en/latest/reference.html). Upon discussion with devs of other RTD-using projects, it appeared that the problem was in the newest version of Sphinx. Thus, I attempted to pin the version of sphinx used in our RTD build to an older version, similarly to what worked for the other devs. I updated our conda environments.yml file to include an old version of sphinx, since that is what we use in our readthedocs.yml file to specify the build environment. Unfortunately, RTD installs the old version successfully, but then it clobbers this version by installing the latest sphinx immediately afterwards. Is there any way to have RTD not install the latest sphinx version, so that we can get autosummary working again?

If you look in the build (see URL below), you'll see where it correctly installs the old version of sphinx as:
conda env create --quiet --name latest --file environment.yml

but then the following line updates to the latest version of sphinx:
conda install --yes --quiet --name latest mock pillow sphinx sphinx_rtd_theme

Expected Result

Leave the version of sphinx to the one specified in the conda environments.yml file.

Actual Result

Gets clobbered by the newest version of sphinx.

@humitos humitos added the Support Support question label Jan 15, 2021
@humitos
Copy link
Member

humitos commented Jan 15, 2021

Hi! If you already pinned the versions you want to install in your environment.yml file you may be hitting this issue #3829. There is a workaround for this issue that involved enabling the feature flag (https://docs.readthedocs.io/en/stable/guides/feature-flags.html#feature-flags) CONDA_APPEND_CORE_REQUIREMENTS in your project.

Users can't enable these flags, so I enabled it for your project and triggered a new build at https://readthedocs.org/projects/trident/builds/12774141/. Please report back if your issue is solved with this.

@humitos humitos added the Needed: more information A reply from issue author is required label Jan 15, 2021
@eric-wieser
Copy link
Contributor

eric-wieser commented Jan 20, 2021

Does the FORCE_SPHINX_FROM_VENV feature flag help here?

Edit: Looks like as of two hours ago that flag is now always on: e5bd237

@stsewd
Copy link
Member

stsewd commented Jan 20, 2021

Edit: Looks like as of two hours ago that flag is now always on: e5bd237

@eric-wieser that commit isn't live yet, but the flag is always on since some days ago.

@stsewd
Copy link
Member

stsewd commented Jan 20, 2021

I can see that the CONDA_APPEND_CORE_REQUIREMENTS flag is working. From the logs

Running Sphinx v3.2.1

@stsewd stsewd closed this as completed Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Development

No branches or pull requests

4 participants