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

Remove ivar documentation if possible #1244

Closed
jeromekelleher opened this issue Mar 15, 2021 · 2 comments
Closed

Remove ivar documentation if possible #1244

jeromekelleher opened this issue Mar 15, 2021 · 2 comments
Labels
documentation Documentation Infrastructure and tools Development infrastructure and tools

Comments

@jeromekelleher
Copy link
Member

We use ivars in a few places in the documentation, but a nasty sphinx bug (sphinx-doc/sphinx#2549) means that they really don't work if you want to have nitpick mode on. We have a workaround monkey patched into setup.cfg.

If we move to JupyterBook, this won't work, as we don't have access to setup.cfg.

I've spent quite a bit of time on this just now in msprime, and the simplest thing to do is to use dataclasses instead and to document each variable separately, like the Population class here:

tskit-dev/msprime#1534

Ideally, we'd do the same here (although we might not have the freedom of using dataclasses)

@jeromekelleher jeromekelleher added documentation Documentation Infrastructure and tools Development infrastructure and tools labels Mar 15, 2021
@hyanwong
Copy link
Member

hyanwong commented Dec 2, 2021

Sphinx bug is fixed, and we've moved to JB. Can this be closed? We probably want to get around to remove some of the ivars anyway (see #1975) but there's presumably no urgency now?

@jeromekelleher
Copy link
Member Author

Yes, let's close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation Infrastructure and tools Development infrastructure and tools
Projects
None yet
Development

No branches or pull requests

2 participants