Skip to content

Enable nitpicky = True on doc configuration #2297

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

Open
einarf opened this issue Jul 22, 2024 · 1 comment
Open

Enable nitpicky = True on doc configuration #2297

einarf opened this issue Jul 22, 2024 · 1 comment
Milestone

Comments

@einarf
Copy link
Member

einarf commented Jul 22, 2024

This will validate all kinds of things such as label and docstring links. To make the docs maintainable this is more or less mandatory to enable. We want do know when links breaks and when having other undefined markup.

I spent a day removing the vast majority of them. The main blocker is that api docs are still not complete. We are missing things like module attributes. In addition the import resolver doesn't work for some parts of arcade such as the gui. That part is likely simple to resolve.

@einarf einarf added this to the 3.1 milestone Jul 22, 2024
@einarf
Copy link
Member Author

einarf commented Mar 27, 2025

50% of the work is done here. There are blocking issues with autodoc resolving external references so nitpicky mode will always complain about those. There's also issues resolving module attributes. If we include them using e.g autodata they are not seen as existing members.

We have at least fixed most of the broken references now.

@einarf einarf changed the title Enable nitpick = True on doc configuration Enable nitpicky = True on doc configuration Mar 29, 2025
@einarf einarf modified the milestones: 3.1, Future Mar 29, 2025
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

1 participant