automatic import of python-mkdocs-markdownextradata-plugin

1 files changed, 546 insertions, 0 deletions

diff --git a/python-mkdocs-markdownextradata-plugin.spec b/python-mkdocs-markdownextradata-plugin.spec
new file mode 100644
index 0000000..93fc06b
--- /dev/null
+++ b/python-mkdocs-markdownextradata-plugin.spec
@@ -0,0 +1,546 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-mkdocs-markdownextradata-plugin
+Version:	0.2.5
+Release:	1
+Summary:	A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
+License:	MIT
+URL:		https://github.com/rosscdh/mkdocs-markdownextradata-plugin/
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/7a/c1/dda03757dbf903a3204ea95ba1e10a2649973ced50382b24a19f09eb35d4/mkdocs-markdownextradata-plugin-0.2.5.tar.gz
+BuildArch:	noarch
+
+
+%description
+# mkdocs-markdownextradata-plugin
+
+[![Build Status](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master)](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin)
+
+*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
+
+**usecase**
+
+```
+As a user with variables that need to be inserted at the markdown level, not the template level.
+I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
+So that I can build my markdown pages with different values for images, urls, client_names, etc. 
+```
+
+## Installation
+
+> **Note:** This package requires MkDocs version 0.17 or higher. 
+
+Install the package with pip:
+
+```bash
+pip install mkdocs-markdownextradata-plugin
+```
+
+Enable the plugin in your `mkdocs.yml`:
+
+```yaml
+plugins:
+    - search
+    - markdownextradata: {}
+```
+
+You are then able to use the mkdocs `extra: {}` hash to pass context data into your files
+
+> **Note:** 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, but now you have to enable it explicitly.
+
+
+## Features
+
+### Use Extra Variables in your markdown files
+
+The variables you define in the mkdown.yml `extra:` slot will become available in your templates
+
+```yaml
+site_name: My fantastic site
+
+plugins:
+    - search
+    - markdownextradata
+
+extra:
+  customer:
+    name: Your name here
+    web: www.example.com
+    salt: salt.example.com
+```
+
+and then in your `*.md` files
+
+```jinja
+{{ customer.name }}
+<a href="{{ customer.web }}">{{ customer.web }}</a>
+```
+
+### Using external data files
+
+If the `extra: {}` hash is not enough for your data then you are able to make use of external yaml files to provide that context data
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles
+```
+
+or if you have multiple locations provide a comma (,) separated list of locations
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles, another/path/to/datafiles
+```
+
+if you leave `markdownextradata.data` empty
+
+```yaml
+plugins:
+    - search
+    - markdownextradata
+```
+
+by default it will search in the folder where your mkdocs.yml is kept
+and in the docs folder for another folder called `_data` 
+(i.e. `./docs/_data/site.yaml`), available as `{{ site.whatever_variable_in_the_yaml}}`.
+
+If these paths are found, the plugin will read all `.yml|.yaml` and `.json`
+files inside them and add the data in them under the `extra` key.
+
+For example, if you have a file called `[path/to/datafiles/]sections/captions.yaml` 
+which includes a variable `foo` - where `[path/to/datafiles/]` is the path declared
+in your configuration under `data` - the data inside that file will be available in
+ your templates as `{{sections.captions.foo}}` or `{{sections['captions']['foo']}}`.
+
+Alternatively, you can access all files and variable declared under `data` in template
+using `extra` key. 
+This is particularly useful if your folder or filename do not comply with the Python
+variable naming rules.
+For example, if you have a file `[path/to/datafiles/]1_example/captions.yaml`
+which includes a variable `bar`, writting the template as 
+`{{1_example.captions.bar}}` returns a `jinja2.exceptions.TemplateSyntaxError` since
+the folder `1_example` starts with a number. Instead, you can call this file with
+ when the template is `{{extra['1_example']['captions']['bar']}}`.
+
+
+### Jinja2 Template Engine Configuration
+
+You may provide [Jinja2 configuration](https://jinja.palletsprojects.com/en/2.11.x/api/#high-level-api) as plugin options:
+
+```yml
+plugins:
+    - markdownextradata:
+        jinja_options:
+          comment_start_string: __CUSTOMCOMMENTSTART__
+```
+
+The above example will make it so that instead of `{#`, the template engine will interpret `__CUSTOMCOMMENTSTART__` as comment start delimiter. This is useful in cases where
+you write Markdown that contains Jinja-like syntax that's colliding with the template engine. Alternatively, it lets you control what the variable delimiter is (instead of the default `{{ }}`).
+
+## Testing
+
+```
+virtualenv venv -p python3.7
+source venv/bin/activate
+python setup.py test
+pytest test
+```
+
+## Contributing
+
+From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
+Report bugs, ask questions and request features using [Github issues][github-issues].
+If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
+
+[travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
+[travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
+[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
+[github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
+[contributing]: CONTRIBUTING.md
+
+### Contributors
+
+- [Ross Crawford-d'Heureuse](https://github.com/rosscdh)
+- [Emiliano Heyns](https://github.com/retorquere)
+- [Michael Jess](https://github.com/miffels)
+- [João Moura](https://github.com/operte)
+
+
+
+
+%package -n python3-mkdocs-markdownextradata-plugin
+Summary:	A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
+Provides:	python-mkdocs-markdownextradata-plugin
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-mkdocs-markdownextradata-plugin
+# mkdocs-markdownextradata-plugin
+
+[![Build Status](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master)](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin)
+
+*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
+
+**usecase**
+
+```
+As a user with variables that need to be inserted at the markdown level, not the template level.
+I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
+So that I can build my markdown pages with different values for images, urls, client_names, etc. 
+```
+
+## Installation
+
+> **Note:** This package requires MkDocs version 0.17 or higher. 
+
+Install the package with pip:
+
+```bash
+pip install mkdocs-markdownextradata-plugin
+```
+
+Enable the plugin in your `mkdocs.yml`:
+
+```yaml
+plugins:
+    - search
+    - markdownextradata: {}
+```
+
+You are then able to use the mkdocs `extra: {}` hash to pass context data into your files
+
+> **Note:** 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, but now you have to enable it explicitly.
+
+
+## Features
+
+### Use Extra Variables in your markdown files
+
+The variables you define in the mkdown.yml `extra:` slot will become available in your templates
+
+```yaml
+site_name: My fantastic site
+
+plugins:
+    - search
+    - markdownextradata
+
+extra:
+  customer:
+    name: Your name here
+    web: www.example.com
+    salt: salt.example.com
+```
+
+and then in your `*.md` files
+
+```jinja
+{{ customer.name }}
+<a href="{{ customer.web }}">{{ customer.web }}</a>
+```
+
+### Using external data files
+
+If the `extra: {}` hash is not enough for your data then you are able to make use of external yaml files to provide that context data
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles
+```
+
+or if you have multiple locations provide a comma (,) separated list of locations
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles, another/path/to/datafiles
+```
+
+if you leave `markdownextradata.data` empty
+
+```yaml
+plugins:
+    - search
+    - markdownextradata
+```
+
+by default it will search in the folder where your mkdocs.yml is kept
+and in the docs folder for another folder called `_data` 
+(i.e. `./docs/_data/site.yaml`), available as `{{ site.whatever_variable_in_the_yaml}}`.
+
+If these paths are found, the plugin will read all `.yml|.yaml` and `.json`
+files inside them and add the data in them under the `extra` key.
+
+For example, if you have a file called `[path/to/datafiles/]sections/captions.yaml` 
+which includes a variable `foo` - where `[path/to/datafiles/]` is the path declared
+in your configuration under `data` - the data inside that file will be available in
+ your templates as `{{sections.captions.foo}}` or `{{sections['captions']['foo']}}`.
+
+Alternatively, you can access all files and variable declared under `data` in template
+using `extra` key. 
+This is particularly useful if your folder or filename do not comply with the Python
+variable naming rules.
+For example, if you have a file `[path/to/datafiles/]1_example/captions.yaml`
+which includes a variable `bar`, writting the template as 
+`{{1_example.captions.bar}}` returns a `jinja2.exceptions.TemplateSyntaxError` since
+the folder `1_example` starts with a number. Instead, you can call this file with
+ when the template is `{{extra['1_example']['captions']['bar']}}`.
+
+
+### Jinja2 Template Engine Configuration
+
+You may provide [Jinja2 configuration](https://jinja.palletsprojects.com/en/2.11.x/api/#high-level-api) as plugin options:
+
+```yml
+plugins:
+    - markdownextradata:
+        jinja_options:
+          comment_start_string: __CUSTOMCOMMENTSTART__
+```
+
+The above example will make it so that instead of `{#`, the template engine will interpret `__CUSTOMCOMMENTSTART__` as comment start delimiter. This is useful in cases where
+you write Markdown that contains Jinja-like syntax that's colliding with the template engine. Alternatively, it lets you control what the variable delimiter is (instead of the default `{{ }}`).
+
+## Testing
+
+```
+virtualenv venv -p python3.7
+source venv/bin/activate
+python setup.py test
+pytest test
+```
+
+## Contributing
+
+From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
+Report bugs, ask questions and request features using [Github issues][github-issues].
+If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
+
+[travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
+[travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
+[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
+[github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
+[contributing]: CONTRIBUTING.md
+
+### Contributors
+
+- [Ross Crawford-d'Heureuse](https://github.com/rosscdh)
+- [Emiliano Heyns](https://github.com/retorquere)
+- [Michael Jess](https://github.com/miffels)
+- [João Moura](https://github.com/operte)
+
+
+
+
+%package help
+Summary:	Development documents and examples for mkdocs-markdownextradata-plugin
+Provides:	python3-mkdocs-markdownextradata-plugin-doc
+%description help
+# mkdocs-markdownextradata-plugin
+
+[![Build Status](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master)](https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin)
+
+*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
+
+**usecase**
+
+```
+As a user with variables that need to be inserted at the markdown level, not the template level.
+I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
+So that I can build my markdown pages with different values for images, urls, client_names, etc. 
+```
+
+## Installation
+
+> **Note:** This package requires MkDocs version 0.17 or higher. 
+
+Install the package with pip:
+
+```bash
+pip install mkdocs-markdownextradata-plugin
+```
+
+Enable the plugin in your `mkdocs.yml`:
+
+```yaml
+plugins:
+    - search
+    - markdownextradata: {}
+```
+
+You are then able to use the mkdocs `extra: {}` hash to pass context data into your files
+
+> **Note:** 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, but now you have to enable it explicitly.
+
+
+## Features
+
+### Use Extra Variables in your markdown files
+
+The variables you define in the mkdown.yml `extra:` slot will become available in your templates
+
+```yaml
+site_name: My fantastic site
+
+plugins:
+    - search
+    - markdownextradata
+
+extra:
+  customer:
+    name: Your name here
+    web: www.example.com
+    salt: salt.example.com
+```
+
+and then in your `*.md` files
+
+```jinja
+{{ customer.name }}
+<a href="{{ customer.web }}">{{ customer.web }}</a>
+```
+
+### Using external data files
+
+If the `extra: {}` hash is not enough for your data then you are able to make use of external yaml files to provide that context data
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles
+```
+
+or if you have multiple locations provide a comma (,) separated list of locations
+
+```yaml
+plugins:
+    - search
+    - markdownextradata:
+        data: path/to/datafiles, another/path/to/datafiles
+```
+
+if you leave `markdownextradata.data` empty
+
+```yaml
+plugins:
+    - search
+    - markdownextradata
+```
+
+by default it will search in the folder where your mkdocs.yml is kept
+and in the docs folder for another folder called `_data` 
+(i.e. `./docs/_data/site.yaml`), available as `{{ site.whatever_variable_in_the_yaml}}`.
+
+If these paths are found, the plugin will read all `.yml|.yaml` and `.json`
+files inside them and add the data in them under the `extra` key.
+
+For example, if you have a file called `[path/to/datafiles/]sections/captions.yaml` 
+which includes a variable `foo` - where `[path/to/datafiles/]` is the path declared
+in your configuration under `data` - the data inside that file will be available in
+ your templates as `{{sections.captions.foo}}` or `{{sections['captions']['foo']}}`.
+
+Alternatively, you can access all files and variable declared under `data` in template
+using `extra` key. 
+This is particularly useful if your folder or filename do not comply with the Python
+variable naming rules.
+For example, if you have a file `[path/to/datafiles/]1_example/captions.yaml`
+which includes a variable `bar`, writting the template as 
+`{{1_example.captions.bar}}` returns a `jinja2.exceptions.TemplateSyntaxError` since
+the folder `1_example` starts with a number. Instead, you can call this file with
+ when the template is `{{extra['1_example']['captions']['bar']}}`.
+
+
+### Jinja2 Template Engine Configuration
+
+You may provide [Jinja2 configuration](https://jinja.palletsprojects.com/en/2.11.x/api/#high-level-api) as plugin options:
+
+```yml
+plugins:
+    - markdownextradata:
+        jinja_options:
+          comment_start_string: __CUSTOMCOMMENTSTART__
+```
+
+The above example will make it so that instead of `{#`, the template engine will interpret `__CUSTOMCOMMENTSTART__` as comment start delimiter. This is useful in cases where
+you write Markdown that contains Jinja-like syntax that's colliding with the template engine. Alternatively, it lets you control what the variable delimiter is (instead of the default `{{ }}`).
+
+## Testing
+
+```
+virtualenv venv -p python3.7
+source venv/bin/activate
+python setup.py test
+pytest test
+```
+
+## Contributing
+
+From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
+Report bugs, ask questions and request features using [Github issues][github-issues].
+If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].
+
+[travis-status]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin.svg?branch=master
+[travis-link]: https://travis-ci.org/rosscdh/mkdocs-markdownextradata-plugin
+[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
+[github-issues]: https://github.com/rosscdh/mkdocs-markdownextradata-plugin/issues
+[contributing]: CONTRIBUTING.md
+
+### Contributors
+
+- [Ross Crawford-d'Heureuse](https://github.com/rosscdh)
+- [Emiliano Heyns](https://github.com/retorquere)
+- [Michael Jess](https://github.com/miffels)
+- [João Moura](https://github.com/operte)
+
+
+
+
+%prep
+%autosetup -n mkdocs-markdownextradata-plugin-0.2.5
+
+%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-markdownextradata-plugin -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.5-1
+- Package Spec generated