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

Follow-up to #7313 - replace explicit ref links to headers with automod #7317

Open
rossbar opened this issue Feb 28, 2024 · 0 comments
Open

Comments

@rossbar
Copy link
Contributor

rossbar commented Feb 28, 2024

#7313 fixed many missing references in NX's objects.inv database by explicitly linking module names to section headings in the docstring.

Another pattern that could be considered is moving the autosummary's for those to the corresponding module docstrings and then using automod in the reference guide to automatically generate everything, and remove any possibility of collision of link names.

To be clear - the current pattern is fine and there shouldn't be any issues! This is just an issue to capture the idea for a minor refactor, it is neither a bug nor high-priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant