Skip to content

Extend the Data Tables page to include info on how to load data from static file#5081

Merged
squidfunk merged 6 commits intosquidfunk:masterfrom
chrimaho:data-tables
Mar 5, 2023
Merged

Extend the Data Tables page to include info on how to load data from static file#5081
squidfunk merged 6 commits intosquidfunk:masterfrom
chrimaho:data-tables

Conversation

@chrimaho
Copy link
Copy Markdown
Contributor

@chrimaho chrimaho commented Feb 21, 2023

Closes:

As discussed here:

We can use the plugin mkdocs-table-reader-plugin to facilitate loading data from a static file.

You'll notice there that in the 'Results' sections, I have manually added the tables as Markdown format... This is because in order to actually render these files using the plugin, it will mean adding new packages to the requirements.txt file, which I think is not desirable for extending docs pages. So can you please adjust this on your side to install the new plugin and render it correctly on the live web page?

Thank you.

Copy link
Copy Markdown
Owner

@squidfunk squidfunk left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I think this is a great addition to our documentation. I only have some minor change requests regarding the structure 😊

Comment thread docs/reference/data-tables.md Outdated
Comment thread docs/reference/data-tables.md Outdated
@chrimaho
Copy link
Copy Markdown
Contributor Author

Thanks @squidfunk! I've now updated it. Please check 👍

Copy link
Copy Markdown
Owner

@squidfunk squidfunk left a comment

Choose a reason for hiding this comment

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

Thanks again! Some additional minor changes – we need to "fake" the output. See comment.

Comment thread docs/reference/data-tables.md Outdated
@chrimaho
Copy link
Copy Markdown
Contributor Author

Thanks @squidfunk! Great feedback. I've now updated it 👍 Please check.

@squidfunk
Copy link
Copy Markdown
Owner

Thanks!

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.

2 participants