diff options
Diffstat (limited to 'python-sphinxcontrib-runcmd.spec')
| -rw-r--r-- | python-sphinxcontrib-runcmd.spec | 299 |
1 files changed, 299 insertions, 0 deletions
diff --git a/python-sphinxcontrib-runcmd.spec b/python-sphinxcontrib-runcmd.spec new file mode 100644 index 0000000..62e667d --- /dev/null +++ b/python-sphinxcontrib-runcmd.spec @@ -0,0 +1,299 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinxcontrib-runcmd +Version: 0.2.0 +Release: 1 +Summary: Sphinx "runcmd" extension +License: MIT +URL: https://github.com/invenia/sphinxcontrib-runcmd +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a2/03/6eb30814c9839f36131284a46ec9fc39d7bd356078648bc7125d5d1c05e8/sphinxcontrib-runcmd-0.2.0.tar.gz +BuildArch: noarch + +Requires: python3-sphinx +Requires: python3-coverage +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-sphinx-testing + +%description +# SphinxContrib RunCmd + +[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master) +[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd) +[](https://pypi.org/project/sphinxcontrib-runcmd) +[](https://www.python.org/) +[](https://github.com/ambv/black) + +Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted. + +## Installation + +sphinxcontrib-runcmd is available on PyPI. To install: + +```sh +$ pip install sphinxcontrib-runcmd +``` + +## Add runcmd to your Project + +First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder: + +```python +extensions = ["sphinxcontrib.runcmd"] +``` + +From there, all you need to do is use `runcmd` as a directive in your documentation files. +```rst +.. runcmd:: python script.py -h + :syntax: bash + :prompt: +``` + +## Options + +This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as: + - linenos + - dedent + - lineno-start + - emphasize-lines + - caption + - class + - name + +This directive builds upon that and adds the following: + - syntax: str + - Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output. + - replace: str + - Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order. + - prompt: bool + - Display the command prompt in the output + - dedent-output: int + - Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options. + +### Replace Option + +The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot. + +You also need to double escape any forward slashes, but you can single escape quotes. + +```rst +.. runcmd:: python test.py -h + :replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'" +``` + +The first replacement will replace `this/is/a/path` with `now/its/another/path`. + +The second replacement will replace `"` with `'`. + +## License + +sphinxcontrib-runcmd is provided under an MIT License. + + + + +%package -n python3-sphinxcontrib-runcmd +Summary: Sphinx "runcmd" extension +Provides: python-sphinxcontrib-runcmd +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinxcontrib-runcmd +# SphinxContrib RunCmd + +[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master) +[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd) +[](https://pypi.org/project/sphinxcontrib-runcmd) +[](https://www.python.org/) +[](https://github.com/ambv/black) + +Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted. + +## Installation + +sphinxcontrib-runcmd is available on PyPI. To install: + +```sh +$ pip install sphinxcontrib-runcmd +``` + +## Add runcmd to your Project + +First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder: + +```python +extensions = ["sphinxcontrib.runcmd"] +``` + +From there, all you need to do is use `runcmd` as a directive in your documentation files. +```rst +.. runcmd:: python script.py -h + :syntax: bash + :prompt: +``` + +## Options + +This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as: + - linenos + - dedent + - lineno-start + - emphasize-lines + - caption + - class + - name + +This directive builds upon that and adds the following: + - syntax: str + - Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output. + - replace: str + - Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order. + - prompt: bool + - Display the command prompt in the output + - dedent-output: int + - Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options. + +### Replace Option + +The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot. + +You also need to double escape any forward slashes, but you can single escape quotes. + +```rst +.. runcmd:: python test.py -h + :replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'" +``` + +The first replacement will replace `this/is/a/path` with `now/its/another/path`. + +The second replacement will replace `"` with `'`. + +## License + +sphinxcontrib-runcmd is provided under an MIT License. + + + + +%package help +Summary: Development documents and examples for sphinxcontrib-runcmd +Provides: python3-sphinxcontrib-runcmd-doc +%description help +# SphinxContrib RunCmd + +[](https://travis-ci.org/invenia/sphinxcontrib-runcmd?branch=master) +[](https://coveralls.io/github/invenia/sphinxcontrib-runcmd) +[](https://pypi.org/project/sphinxcontrib-runcmd) +[](https://www.python.org/) +[](https://github.com/ambv/black) + +Sphinx RunCmd aims to allow you to place the output of arbitrary commands in your rst files, while also giving you greater flexibility in how the output is formatted. + +## Installation + +sphinxcontrib-runcmd is available on PyPI. To install: + +```sh +$ pip install sphinxcontrib-runcmd +``` + +## Add runcmd to your Project + +First you'll want to add `sphinxcontrib.runcmd` to your `conf.py` file in your docs folder: + +```python +extensions = ["sphinxcontrib.runcmd"] +``` + +From there, all you need to do is use `runcmd` as a directive in your documentation files. +```rst +.. runcmd:: python script.py -h + :syntax: bash + :prompt: +``` + +## Options + +This directive is basically a sub-directive of `code-block`, so it has all of code blocks directives such as: + - linenos + - dedent + - lineno-start + - emphasize-lines + - caption + - class + - name + +This directive builds upon that and adds the following: + - syntax: str + - Since we're using the arguments section for a command we can't actually pass the syntax we want to the `code-block` in the arguments. Therefore you can set it in the options which will then get passed into the `code-block` to colorize your commands output. + - replace: str + - Takes in a comma separated list of regex `pattern/replace,pattern/replace` and applies it to the output in that order. + - prompt: bool + - Display the command prompt in the output + - dedent-output: int + - Will dedent the output only by the int value you specify. Will not dedent the prompt if specified. Be careful, because the `code-block` dedent will be applied on top of this dedent if both are set in the options. + +### Replace Option + +The `replace` option uses the `CSV` package to parse the string, thus you can wrap your replacements in double quotes if you want to use commas and whatnot. + +You also need to double escape any forward slashes, but you can single escape quotes. + +```rst +.. runcmd:: python test.py -h + :replace: "this\\/is\\/a\\/path/now\\/its\\/another\\/path","\"/'" +``` + +The first replacement will replace `this/is/a/path` with `now/its/another/path`. + +The second replacement will replace `"` with `'`. + +## License + +sphinxcontrib-runcmd is provided under an MIT License. + + + + +%prep +%autosetup -n sphinxcontrib-runcmd-0.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-sphinxcontrib-runcmd -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.0-1 +- Package Spec generated |