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

Fix coloc docs #20

Merged
merged 3 commits into from
Feb 6, 2024
Merged

Fix coloc docs #20

merged 3 commits into from
Feb 6, 2024

Conversation

aeisenbarth
Copy link
Collaborator

The colocalization was not included in documentation.

This was because we have Sphinx set up to document only explicitly (discovery with sphinx-apidoc often gives unwanted results). automodule has an option :imported-members: but it only includes directly imported functions, not modules.

So I added a separate, explicit section for the colocalization module.

Closes #19

@tdrose tdrose self-requested a review February 6, 2024 10:43
Copy link
Member

@tdrose tdrose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks for fixing typos.

@tdrose tdrose merged commit f242a01 into master Feb 6, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Colocalization not in documentation
2 participants