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

Sphinx 3 issues #198

Closed
jamesjer opened this issue Apr 16, 2020 · 3 comments
Closed

Sphinx 3 issues #198

jamesjer opened this issue Apr 16, 2020 · 3 comments

Comments

@jamesjer
Copy link
Contributor

The Fedora Linux distribution has started the process of switching from sphinx 2 to sphinx 3. The yices package fails to build its documentation with sphinx 3. There are two issues:

  1. sphinx.locale.l_, which was deprecated in sphinx 2, has been removed entirely from sphinx 3. This affects both sphinx extensions: cenum.py and cheader.py. The _ function should be used instead.
  2. Sphinx 3 provides an enum role and an enum directive, so cenum.py is not needed. In fact, it doesn't work at all due to changes in CDomain in sphinx 3.
@BrunoDutertre
Copy link
Member

Thanks Jerry. I'll look into this. Paradoxically, Sphinx's own documentation is still as horrible
as I remember.

@BrunoDutertre
Copy link
Member

I've tried to fix conf.py in to handle this in 52d025a.
@jamesjer Can you check whether it works for you?

@jamesjer
Copy link
Contributor Author

Thanks for the quick fix! That commit does indeed resolve the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants