diff options
Diffstat (limited to 'python-mkdocs-table-reader-plugin.spec')
| -rw-r--r-- | python-mkdocs-table-reader-plugin.spec | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/python-mkdocs-table-reader-plugin.spec b/python-mkdocs-table-reader-plugin.spec new file mode 100644 index 0000000..8fab5da --- /dev/null +++ b/python-mkdocs-table-reader-plugin.spec @@ -0,0 +1,220 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mkdocs-table-reader-plugin +Version: 2.0 +Release: 1 +Summary: MkDocs plugin to directly insert tables from files into markdown. +License: MIT +URL: https://github.com/timvink/mkdocs-table-reader-plugin +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/af/3e/0c09597972bc17ef35331916bab6f77cca5374b2708f5304e92281acc5cc/mkdocs-table-reader-plugin-2.0.tar.gz +BuildArch: noarch + +Requires: python3-mkdocs +Requires: python3-pandas +Requires: python3-tabulate +Requires: python3-PyYAML + +%description +[](https://github.com/timvink/mkdocs-table-reader-plugin/actions) + + + +[](https://codecov.io/gh/timvink/mkdocs-table-reader-plugin) + + + +# mkdocs-table-reader-plugin + +[MkDocs](https://www.mkdocs.org/) plugin that enables a markdown tag like `{{ read_csv('table.csv') }}` to directly insert various table formats into a page. + +> For a workflow with other plugins see the blogpost [building reproducible reports with MkDocs](https://timvink.nl/reproducible-reports-with-mkdocs/) + +## Installation + +Install the plugin using `pip`: + +```bash +pip install mkdocs-table-reader-plugin +``` + +Next, add the following lines to your `mkdocs.yml`: + +```yml +plugins: + - search + - table-reader +``` + +> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set. + +## Usage + +In your markdown documents you can now use: + +```html +{{ read_csv('path_to_table.csv') }} +``` + +Where the path is relative to the location of your project's `mkdocs.yml` file (although you can [change that](https://timvink.github.io/mkdocs-table-reader-plugin/options) to be relative to your `docs/` directory). + +- There are [readers](https://timvink.github.io/mkdocs-table-reader-plugin/readers/) for `.csv`, `.fwf`, `.json`, `.xlsx`, `.yaml` and `.tsv`. There is also the `read_raw()` reader that will allow you to insert tables (or other content) already in markdown format. +- See the [how to guides](https://timvink.github.io/mkdocs-table-reader-plugin/howto/customize-tables/) for example of various workflows + +## Documentation + +See [timvink.github.io/mkdocs-table-reader-plugin/](https://timvink.github.io/mkdocs-table-reader-plugin/) + + +%package -n python3-mkdocs-table-reader-plugin +Summary: MkDocs plugin to directly insert tables from files into markdown. +Provides: python-mkdocs-table-reader-plugin +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mkdocs-table-reader-plugin +[](https://github.com/timvink/mkdocs-table-reader-plugin/actions) + + + +[](https://codecov.io/gh/timvink/mkdocs-table-reader-plugin) + + + +# mkdocs-table-reader-plugin + +[MkDocs](https://www.mkdocs.org/) plugin that enables a markdown tag like `{{ read_csv('table.csv') }}` to directly insert various table formats into a page. + +> For a workflow with other plugins see the blogpost [building reproducible reports with MkDocs](https://timvink.nl/reproducible-reports-with-mkdocs/) + +## Installation + +Install the plugin using `pip`: + +```bash +pip install mkdocs-table-reader-plugin +``` + +Next, add the following lines to your `mkdocs.yml`: + +```yml +plugins: + - search + - table-reader +``` + +> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set. + +## Usage + +In your markdown documents you can now use: + +```html +{{ read_csv('path_to_table.csv') }} +``` + +Where the path is relative to the location of your project's `mkdocs.yml` file (although you can [change that](https://timvink.github.io/mkdocs-table-reader-plugin/options) to be relative to your `docs/` directory). + +- There are [readers](https://timvink.github.io/mkdocs-table-reader-plugin/readers/) for `.csv`, `.fwf`, `.json`, `.xlsx`, `.yaml` and `.tsv`. There is also the `read_raw()` reader that will allow you to insert tables (or other content) already in markdown format. +- See the [how to guides](https://timvink.github.io/mkdocs-table-reader-plugin/howto/customize-tables/) for example of various workflows + +## Documentation + +See [timvink.github.io/mkdocs-table-reader-plugin/](https://timvink.github.io/mkdocs-table-reader-plugin/) + + +%package help +Summary: Development documents and examples for mkdocs-table-reader-plugin +Provides: python3-mkdocs-table-reader-plugin-doc +%description help +[](https://github.com/timvink/mkdocs-table-reader-plugin/actions) + + + +[](https://codecov.io/gh/timvink/mkdocs-table-reader-plugin) + + + +# mkdocs-table-reader-plugin + +[MkDocs](https://www.mkdocs.org/) plugin that enables a markdown tag like `{{ read_csv('table.csv') }}` to directly insert various table formats into a page. + +> For a workflow with other plugins see the blogpost [building reproducible reports with MkDocs](https://timvink.nl/reproducible-reports-with-mkdocs/) + +## Installation + +Install the plugin using `pip`: + +```bash +pip install mkdocs-table-reader-plugin +``` + +Next, add the following lines to your `mkdocs.yml`: + +```yml +plugins: + - search + - table-reader +``` + +> If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set. + +## Usage + +In your markdown documents you can now use: + +```html +{{ read_csv('path_to_table.csv') }} +``` + +Where the path is relative to the location of your project's `mkdocs.yml` file (although you can [change that](https://timvink.github.io/mkdocs-table-reader-plugin/options) to be relative to your `docs/` directory). + +- There are [readers](https://timvink.github.io/mkdocs-table-reader-plugin/readers/) for `.csv`, `.fwf`, `.json`, `.xlsx`, `.yaml` and `.tsv`. There is also the `read_raw()` reader that will allow you to insert tables (or other content) already in markdown format. +- See the [how to guides](https://timvink.github.io/mkdocs-table-reader-plugin/howto/customize-tables/) for example of various workflows + +## Documentation + +See [timvink.github.io/mkdocs-table-reader-plugin/](https://timvink.github.io/mkdocs-table-reader-plugin/) + + +%prep +%autosetup -n mkdocs-table-reader-plugin-2.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mkdocs-table-reader-plugin -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0-1 +- Package Spec generated |