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

confusion noise functions not showing up in docs #90

Closed
dbkeitel opened this issue Jan 27, 2022 · 1 comment · Fixed by #92
Closed

confusion noise functions not showing up in docs #90

dbkeitel opened this issue Jan 27, 2022 · 1 comment · Fixed by #92
Labels
documentation Improvements or additions to documentation

Comments

@dbkeitel
Copy link

Which documentation page is causing an issue?
https://legwork.readthedocs.io/en/latest/modules.html#module-legwork.psd

What is the problem?
The LISA/TQ function documentations refer to legwork.psd.get_confusion_noise() but that identifier is not clickable, and I can't actually find that function (nor the specific implementations of confusion noise) anywhere in the API docs.

Suggested solution (optional)
The docstrings in https://github.com/TeamLEGWORK/LEGWORK/blob/main/legwork/psd.py look valid to me, so maybe the functions need to be added manually somewhere to sphinx...?

@TomWagg
Copy link
Collaborator

TomWagg commented Jan 27, 2022

Ah nice catch! Sphinx only makes docs for functions in the all list at the top, so I just need to add them to that, will do!

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

Successfully merging a pull request may close this issue.

2 participants