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

Review nitpicky warnings from Sphinx #240

Open
lewisjared opened this issue May 17, 2023 · 0 comments
Open

Review nitpicky warnings from Sphinx #240

lewisjared opened this issue May 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@lewisjared
Copy link
Collaborator

Describe the bug

Sphinx raises lots of nit picking errors due to slight inaccuracies with cross-referencing different functions and classes. It would be good to clean these up.

Currently we don't fail on warnings when building the docs so small errors may creep through. Once this is cleaned up we might be able to tighten the raise error on warning flag (-W).
@lewisjared lewisjared added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lewisjared