Update dependency mkdocs-table-reader-plugin to v4 - #110
Open
renovate[bot] wants to merge 1 commit into
Open
renovate[bot] wants to merge 1 commit into
renovate[bot] wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==2.2.2→==4.0.1Release Notes
timvink/mkdocs-table-reader-plugin (mkdocs-table-reader-plugin)
v4.0.1Compare Source
Bug fixes:
=inside an argument value no longer breaks parsing.{{ read_csv('a=b.csv') }},sep='='andna_values=['a=1']all raised aSyntaxErrorbefore.dtype={'a': 'str', 'b': 'int'}works. Lists and tuples already worked.convert_to_md_table()no longer escapes pipe characters in the DataFrame you pass in. When amkdocs-macros-pluginuser rendered the same DataFrame twice, the second table showed doubly escaped pipes.Project maintenance:
master. It was deployed by hand, and had fallen behind the readers added in 4.0.0.enabledis included inschema.json, so editors stop flagging it as an unknown option.v4.0.0: table-reader v4.0.0Compare Source
Breaking changes
convert_to_md_table()used to pick between.map()and.applymap()on a string comparison ofpd.__version__..applymap()was removed in pandas 3, so that branch is gone and the floor is now the pandas release that addedpd.DataFrame.map().New readers
Readers for every remaining file format that pandas can read, so the plugin now covers all of them (readers):
read_feather,read_parquet,read_orc,read_html,read_xml,read_hdf,read_sas,read_spssandread_stata, each also available as apd_<reader>macro whenmkdocs-macros-pluginis enabled. Some need an extra package installed, which the readers page lists per format.Faster builds
Every reader used to run its own regex over every page, so each reader added made builds slower. All selected readers are now searched for in one pattern, and a page is scanned once no matter how many readers are selected. Scanning a 15KB page:
That is 8x faster with the readers v3 had, and 17x faster with all the readers v4 adds: about a second saved per 1000 pages.
select_readersis no longer needed to keep builds fast.Improvements
<br>for single-line table formats likepipeandgithub, and left alone for formats that display multiline cells themselves, such asgrid(#83).read_yaml()andread_raw()accept anencodingargument, for files that are not UTF-8. Thanks @kirill237!Internal
select_readers,allow_missing_files, tag indentation and malformed tags all have tests now, and theread_hdf()andread_spss()tests actually run in CI instead of always skipping.Full Changelog: timvink/mkdocs-table-reader-plugin@v3.1.0...v4.0.0
v3.1.0: table-reader v3.1.0Compare Source
pd_<reader_name>macros (overview on the readers page), available whenmkdocs-macros-pluginis enabled. This enables new options like filtering tables, see the examples on the compatibility with mkdocs-macros-pluginFull Changelog: timvink/mkdocs-table-reader-plugin@v3.0.1...v3.1.0
v3.0.1: table-reader v3.0.1Compare Source
What's Changed
mkdocs-macros-pluginwith indented content like tabs. See the how to on using jinja2. by @timvink in #69Full Changelog: timvink/mkdocs-table-reader-plugin@v3.0.0...v3.0.1
v3.0.0: table-reader v3.0.0Compare Source
What's Changed
table-readeris now compatible withmkdocs-macros-plugin, which means you can dynamically insert tables using jinja2 syntax.base_pathoption has now been deprecated (and will log a warning when used). Now by default, the config_dir (path to yourmkdocs.ymlfile) and docs_dir (path to yourdocs/dir) will always be searched when looking for a table file pathsearch_page_directoryoption has now been deprecated (and will log a warning when used). The markdown page's source file directory will always be searched when looking for a table file.Breaking changes / upgrading guide
base_pathandsearch_page_directoryfrom yourmkdocs.ymloptions.mkdocs.ymlfile, themacrosplugin should be defined before thetable-readerplugin (previously this was after)Full Changelog: timvink/mkdocs-table-reader-plugin@v2.2.2...v3.0.0
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.