Skip to content

Use grid-style tables for member lists #105

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

Closed
wants to merge 2 commits into from

Conversation

jnothman
Copy link
Member

However: this causes the PDF build for scikit-learn to fail:

writing...
Markup is unsupported in LaTeX:
modules/generated/sklearn.model_selection.GridSearchCV:: nested tables are not yet implemented.

IIUC, the main reason to be using tables rather than definition lists is for consistency with the autosummary listing. Is there any problem with reimplementing the autosummary listing as a definition list? If we don't have .. autosummary will the doc pages for attributes not be generated?

Ping @amueller

jnothman added 2 commits July 25, 2017 10:22
Supports multi-line attribute descriptions (Fixes numpy#104)

- Attribute type spec is now on a separate line to description
@jnothman
Copy link
Member Author

Reimplementing autosummary is going to be a bit hacky, in order to get signatures and documentation summaries right, but might still be the best approach to meet all our needs.

@jnothman
Copy link
Member Author

I think this is a strict improvement on the status quo. But it still doesn't satisfy scikit-learn's needs.

@amueller
Copy link
Contributor

What needs are not met by this? The PDF issue?
How does this look?

out += [hdr]
desc = [param_type, ''] + desc
table.append(["**" + param.strip() + "**", desc])
out += ['', ''] + _grid_table_rst(table)
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the reason to use grid tables? simple tables are supposed to support multi-line rows:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables

(unless that might be too fragile?)

@jnothman
Copy link
Member Author

jnothman commented Aug 1, 2017 via email

@amueller
Copy link
Contributor

amueller commented Aug 1, 2017

Off topic: It would be great if github's email detection would be better. Or maybe there's something you could change about your email formatting? Having the the full quote on the website sometimes makes me overlook parts that you actually wrote.

I can live with the sub-ideal points if the alternative is touching autosummary. I think using the other table format might make this PR a bit lighter.

@amueller
Copy link
Contributor

amueller commented Aug 1, 2017

We could move the table to the notes or the top level section?

@jnothman
Copy link
Member Author

jnothman commented Aug 1, 2017 via email

@amueller
Copy link
Contributor

amueller commented Aug 1, 2017 via email

@jnothman
Copy link
Member Author

jnothman commented Aug 1, 2017 via email

@jnothman
Copy link
Member Author

Closing following merge of #106

@jnothman jnothman closed this Sep 10, 2017
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.

3 participants