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

Enable Sphinx nitpick #227

Open
DiamondJoseph opened this issue Apr 17, 2024 · 0 comments · May be fixed by #654
Open

Enable Sphinx nitpick #227

DiamondJoseph opened this issue Apr 17, 2024 · 0 comments · May be fixed by #654
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@DiamondJoseph
Copy link
Contributor

Sphinx nitpick mode has always been disabled since the project was initially created as part of the ophyd repository.
This means the docs may be full of links that are intended to be linking to internal and external docstrings.
This should be re-enabled and the references that are not working should be fixed.
The copier template attempted to set this to true but this blocked other issues from progressing.

n.b. this is in docs/conf.py

@DiamondJoseph DiamondJoseph added bug Something isn't working documentation Improvements or additions to documentation labels Apr 17, 2024
@coretl coretl added this to the 1.0 milestone Jul 19, 2024
@stan-dot stan-dot linked a pull request Nov 18, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants