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.

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

Update Sphinx version to remove sphinx_autodoc_typehints dependency #264

Closed
goodmami opened this issue Dec 20, 2019 · 1 comment
Closed

Update Sphinx version to remove sphinx_autodoc_typehints dependency #264

goodmami opened this issue Dec 20, 2019 · 1 comment
Labels
maintenance improving code quality; not features or bugs
Milestone
v1.1.0

Comments

@goodmami
Copy link
Member

We've been using sphinx_autodoc_typehints only to remove typehints from the documentation and not to insert them as parameter types. As of Sphinx 2.2.0, Sphinx can do the same thing (it could do the basic removal for a while now but some patterns were not formatted correctly; see this pull request). So we can now remove the second dependency if we update Sphinx to use 2.2.0, at least.
@goodmami goodmami added the maintenance improving code quality; not features or bugs label Dec 20, 2019
@goodmami
Copy link
Member Author

This was done in 91b62c4.

goodmami added a commit that referenced this issue Dec 20, 2019
@goodmami
Remove old dependency from docs/requirements.txt
8954e04 
sphinx_autodoc_typehints was removed as a dependency but I forgot to
remove the corresponding line from docs/requirements.txt.

Part of #264
@goodmami goodmami added this to the v1.1.0 milestone Dec 20, 2019
@goodmami goodmami closed this as completed Jan 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
maintenance improving code quality; not features or bugs
Projects
None yet
Milestone
v1.1.0
Development

No branches or pull requests
1 participant
@goodmami