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 does not follow paths for class aliases for parameter types #61

Open
mattsb42-aws opened this issue Jul 25, 2018 · 2 comments
Open

Comments

@mattsb42-aws
Copy link
Member

mattsb42-aws commented Jul 25, 2018

Problem

Even though Algorithm is an alias for AlgorithmSuite, it looks like the sphinx module that generates code links for parameter types doesn't realize that and just treats it as an unknown class.

ex:

render:

https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.html#aws_encryption_sdk.encrypt

src:

https://github.com/aws/aws-encryption-sdk-python/blob/master/src/aws_encryption_sdk/__init__.py#L72-L73

Solution

Replace parameter type references with AlgorithmSuite.

@4gatepylon
Copy link

Made a PR Request.

@acioc
Copy link

acioc commented Dec 5, 2020

Closed stale PR for this issue

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

No branches or pull requests

3 participants