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.

Sign up for GitHub

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

Jump to bottom

Fixes for docs rendering #145

Merged

kislyuk merged 2 commits into pyauth:develop from alexfikl:fix-doc-types

Nov 12, 2022

alexfikl commented Nov 11, 2022

This has two small modifications:

adds sphinx.ext.intersphinx to link types back to https://docs.python.org/3/library/typing.html
Remove a default value in the TOTP / HOTP classes so the type hints get rendered correctly (this is likely a bug in sphinx and just working around it).

This is how it currently looks on https://pyauth.github.io/pyotp/#pyotp.totp.TOTP

And this is after the changes in the current PR

alexfikl added 2 commits

November 11, 2022 20:18


          enable intersphinx links

123cc6c


          fix type hints in TOTP and HOTP classes

9b415c4

kislyuk merged commit 03045d5 into pyauth:develop

Member

kislyuk commented Nov 12, 2022

Thanks!

alexfikl deleted the fix-doc-types branch

November 12, 2022 16:44

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment