-
Notifications
You must be signed in to change notification settings - Fork 66
docs: add a how-to guide for data tables #451
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
Conversation
|
@AnneCYH I've started drafting the how-to guide for data tables. Want to get your input on something... On the how-to guides landing page (preview), I'm putting the new guide under "Optional features and workflows". However, this guide also covers non-interactive data tables, which are supported by default in the starter pack. I'm not totally satisfied with this approach - what's your opinion? |
|
Hi @dwilding , I agree it isn't entirely accurate. I would suggest rewording the description for that section instead to be clear that some are already ready to use by default. Additional features and workflowsAs your documentation grows, you may need more advanced features to support richer content. This can include diagrams as code, automated API references, and data tables. While some of these features are available by default in the starter pack, others may require additional extensions. The following guides will help you get started:
|
|
Thanks @AnneCYH, I like your suggestion! I've updated this PR to use that wording. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. A few minor suggestions but nothing blocking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
Thanks @minaelee, @medubelko, @AnneCYH! I've made updates from all feedback. This is ready to merge after a tick from Minae |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ty!
This PR adds a how-to guide for rendering CSV data as tables. It covers the included
csv-tabledirective and the non-includedSphinx DataTablesextension.Preview doc