search

ammaraskar / sphinx-action

Github action that builds docs using sphinx and places errors inline
Apache License 2.0
189 stars 114 forks source link

Error with `sphinx==4.1.0` #30

Closed ethanwharris closed 3 years ago

ethanwharris commented 3 years ago

Hi @ammaraskar thanks for this action!

We've noticed that our sphinx build CI has stopped working since the release of sphinx 4.1.0. Our action is here: https://github.com/PyTorchLightning/pytorch-lightning/blob/e5732a11583572f13c68c02cf50a26fd9863229a/.github/workflows/docs-checks.yml#L11

The error we are getting is:

Could not import extension sphinx.builders.epub3 (exception: cannot import name 'RemovedInSphinx40Warning' from 'sphinx.deprecation' (/usr/local/lib/python3.8/site-packages/sphinx/deprecation.py))

You can see the failing CI here: https://github.com/PyTorchLightning/pytorch-lightning/pull/7960/checks?check_run_id=3044973574#step:4:435

I'm not sure what the cause of the error is so any help you can give us would be awesome. Thanks :smiley:

kapilt commented 3 years ago

That has nothing to do with this action, this action doesn’t import any sphinx code, thats related to your project’s use of sphinx and should be taken to the sphinx community / project to learn more about the error and the upgrade needed in your project’s use of sphinx.

ethanwharris commented 3 years ago

Hi @kapilt thanks for the clarification, we weren't really sure about the cause of the error.