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

docs: recent sphinx-build warns about 'rfc' role being overridden #7

Closed
elliefm opened this issue Jul 22, 2016 · 4 comments
Closed
Assignees
Labels
3.0 affects 3.0

Comments

@elliefm
Copy link
Contributor

elliefm commented Jul 22, 2016

When building our docs with sphinx-build 1.4.5:

WARNING: while setting up extension ?: role 'rfc' is already registered, it will be overridden

Our rfc is defined in docsrc/conf.py:

        'rfc':('http://tools.ietf.org/html/rfc%s', 'RFC '),

The thing is, sphinx already has such a thing built in. And looks like it has had it built in pretty much forever: sphinx-doc/sphinx@d60ca8d

The difference with the newer version of sphinx-build appears to be that it now warns about us overriding built-in functionality, instead of just quietly doing it. We should be able to shut up this warning just by no longer defining our own rfc role. The built-in one does basically the same thing anyway (except that it uses a https link to the same destination -- good!).

We need to support at least back to version 1.3.6, because that's what the website rebuild uses, but I can't easily test that version now that I've upgraded.

@elliefm elliefm self-assigned this Jul 22, 2016
@nicolan
Copy link

nicolan commented Jul 26, 2016

I'm running sphinx 1.3.6

I yanked the rfc entry in conf.py and everything built beautifully.

@nicolan
Copy link

nicolan commented Jul 26, 2016

I can't seem to assign it to me or mark it fixed.

commit 3a004c1

@elliefm
Copy link
Contributor Author

elliefm commented Jul 26, 2016

@nicolan Awesome, thanks, #10 has been merged. I've sent you an invite to the cyrusimap group, once you accept it I think you'll be able to assign/close issues.

I'll leave this one hanging open for now so you can try it out

@nicolan nicolan assigned nicolan and unassigned elliefm Jul 27, 2016
@nicolan
Copy link

nicolan commented Jul 27, 2016

Pull request merged. Closing issue.
And confirming permissions work!

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

No branches or pull requests

2 participants