Releases: timvink/mkdocs-table-reader-plugin
Releases · timvink/mkdocs-table-reader-plugin
table-reader v3.1.0
- Improved documentation on Compatibility with mkdocs-macros-plugin
- Added additional
pd_<reader_name>
macros (overview on the readers page), available whenmkdocs-macros-plugin
is enabled. This enables new options like filtering tables, see the examples on the compatibility with mkdocs-macros-plugin
Full Changelog: v3.0.1...v3.1.0
table-reader v3.0.1
What's Changed
- Add support for fixing indentation when using
mkdocs-macros-plugin
with indented content like tabs. See the how to on using jinja2. by @timvink in #69
Full Changelog: v3.0.0...v3.0.1
table-reader v3.0.0
What's Changed
table-reader
is now compatible withmkdocs-macros-plugin
, which means you can dynamically insert tables using jinja2 syntax.- The
base_path
option has now been deprecated (and will log a warning when used). Now by default, the config_dir (path to yourmkdocs.yml
file) and docs_dir (path to yourdocs/
dir) will always be searched when looking for a table file path - The
search_page_directory
option 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
- Remove
base_path
andsearch_page_directory
from yourmkdocs.yml
options.
# mkdocs.yml
plugins:
- - table-reader:
- base_path: docs_dir
- search_page_directory: True
+ - table-reader
- In your
mkdocs.yml
file, themacros
plugin should be defined before thetable-reader
plugin (previously this was after)
# mkdocs.yml
plugins:
- - table-reader
- - macros
+ - macros
+ - table-reader
Full Changelog: v2.2.2...v3.0.0
table-reader v2.2.2
What's Changed
Full Changelog: v2.2.1...v2.2.2
table-reader v2.2.1
What's Changed
Full Changelog: v2.2.0...v2.2.1
table-reader v2.2.0
What's Changed
- Create
schema.json
file to support auto-completion in IDEs by @blakenetz in #58 - Add codespell support (config, workflow to detect/not fix) and make it fix few typos by @yarikoptic in #59
- New args/kwargs string parsing, that now supports passing lists to arguments. Fixed by @timvink in 170e82c
The example below has an argument with a comma separated list, that would lead to an error before, but now works:
{{ read_csv("file.csv", usecols=['A', 'B']) }}
New Contributors
- @blakenetz made their first contribution in #58
- @yarikoptic made their first contribution in #59
Full Changelog: v2.1.0...v2.2.0
table-reader v2.1.0
What's Changed
- Add
read_feather
reader by @BartvanWoesik in #56 - Add
select_readers
option for reducing build times for large sites (see docs) by @BartvanWoesik in #56 - Drop support for python 3.7
Full Changelog: v2.0.3...v2.1.0
table-reader v2.0.3
Fix regression, df.map
is only available from pandas>=2.1.0
..
Full Changelog: v2.0.2...v2.0.3
table-reader v2.0.2
Full Changelog:
- Avoid deprecationwarning of
pandas.applymap
inpandas
>= 2.0.0 (#55)
table-reader v2.0.1
What's Changed
Bugfixes:
- Bugfix in
kwargs_in_func
where arguments parsing sometimes lead to errors by @BartvanWoesik in #51
Documentation:
- Add guide on using mkdocs-material docer in 355224f by @timvink (see #46)
- Update broken link in README in e99b028 by @timvink (see #49)
- Add multiline yaml to examples in e9ca472 by @timvink (see #47)
New Contributors
- @BartvanWoesik made their first contribution in #51
Full Changelog: v2.0...v2.0.1