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

@requires decorator confuses sphinx #159

Open
landreman opened this issue Nov 5, 2021 · 1 comment
Open

@requires decorator confuses sphinx #159

landreman opened this issue Nov 5, 2021 · 1 comment

Comments

@landreman
Copy link
Contributor

When the docs have a link to a class, using e.g.

:obj:`simsopt.util.mpi.MpiPartition`

the link does not work if the class has the @requires decorator. I noticed this problem in particular for the links to MpiPartition in
https://simsopt.readthedocs.io/en/latest/concepts.html#mpi-partitions-and-worker-groups
If the @requires decorator is removed from MpiPartition, the links in the docs work again.
@landreman
Copy link
Contributor Author

The same problem occurs if the SimsoptRequires decorator is used instead of requires.

@landreman landreman mentioned this issue Dec 23, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@landreman