diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-10 16:21:37 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-10 16:21:37 +0000 |
commit | 50e403738ddc46b5bd3de360b00d78fa5729bd38 (patch) | |
tree | 48a4d444ecaf8db594af5bb1d940e65ba49c9794 | |
parent | ecd09cd6f0f0013c7a1c0b0b478afb94acbd2638 (diff) |
automatic import of python-sphinx-tabs
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-sphinx-tabs.spec | 663 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 665 insertions, 0 deletions
@@ -0,0 +1 @@ +/sphinx-tabs-3.4.1.tar.gz diff --git a/python-sphinx-tabs.spec b/python-sphinx-tabs.spec new file mode 100644 index 0000000..71077d7 --- /dev/null +++ b/python-sphinx-tabs.spec @@ -0,0 +1,663 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinx-tabs +Version: 3.4.1 +Release: 1 +Summary: Tabbed views for Sphinx +License: MIT +URL: https://github.com/executablebooks/sphinx-tabs +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/aa/9b/a54949728ff067e4d0997c934e97569dbf3bb4e9c0d63ff3377be4cc3831/sphinx-tabs-3.4.1.tar.gz +BuildArch: noarch + +Requires: python3-sphinx +Requires: python3-pygments +Requires: python3-docutils +Requires: python3-pre-commit +Requires: python3-coverage +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-pytest-regressions +Requires: python3-pygments +Requires: python3-sphinx-testing +Requires: python3-bs4 +Requires: python3-rinohtype + +%description +# sphinx-tabs + +[![Github-CI][github-ci]][github-link] +[![Coverage Status][codecov-badge]][codecov-link] +[![PyPI][pypi-badge]][pypi-link] + +Create tabbed content in [Sphinx documentation](http://www.sphinx-doc.org) when building HTML. + +For example, see the [Raw] code of [docs/index.rst](docs/index.rst) which generates the following: + +A live demo can be found here: <https://sphinx-tabs.readthedocs.io> + + + +## Installation + +```bash +pip install sphinx-tabs +``` + +To enable the extension in Sphinx, add the following to your conf.py: + +```python +extensions = ['sphinx_tabs.tabs'] +``` + +If needed, there is a configuration option to allow additional builders to be considered compatible. For example, to add the `linkcheck` builder, add the following to your conf.py: + +```python +sphinx_tabs_valid_builders = ['linkcheck'] +``` + +If you are using [Read The Docs](https://readthedocs.org/) for building your documentation, the extension must be added as a requirement. Please add the following to `requirements.txt` at the root of the project: + +``` +sphinx-tabs +``` + +## Contributing + +We welcome all contributions! +See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details. + +The simplest way to run tests is to install [pre-commit](https://pre-commit.com/) for linting and [tox](https://tox.readthedocs.io) for unit tests and documentation build: + +```console +$ pre-commit run --all +``` + +```console +$ tox -p +``` + +## Basic Tabs + +Basic tabs can be coded as follows: + +```rst +.. tabs:: + + .. tab:: Apples + + Apples are green, or sometimes red. + + .. tab:: Pears + + Pears are green. + + .. tab:: Oranges + + Oranges are orange. +``` + + + +The contents of each tab can be displayed by clicking on the tab that you wish to show. Clicking on the tab that is currently open will hide the tab's content, leaving only the tab set labels visible. + +Alternatively, tab sets can be focused using :kbd:`Tab`. The :kbd:`Left Arrow` and :kbd:`Right Arrow` keys can then be used to navigate across the tab set and :kbd:`Enter` can be used to select a tab. + +## Grouped Tabs + +Tabs can be grouped, so that changing the current tab in one tabset changes the current tab in all other tabsets containing a tab with a matching label. +For example: + +```rst +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 + +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 +``` + + + +If permitted by the user's browser, the last selected group tab will be remembered when changing page. As such, if any tabsets on the next page contain a tab with the same label it will be selected. + + +## Code Tabs + +Grouped tabs containing code with syntax highlighting can be created as follows: + +```rst +.. tabs:: + + .. code-tab:: c + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: c++ + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py + + def main(): + return + + .. code-tab:: java + + class Main { + public static void main(String[] args) { + } + } + + .. code-tab:: julia + + function main() + end + + .. code-tab:: fortran + + PROGRAM main + END PROGRAM main +``` + + + +Code tabs also support custom lexers (added via sphinx `conf.py`). Pass the lexers alias as the first argument of `code-tab`. + +By default, code tabs are labelled with the language name, though a custom label can be provided as an optional second argument to the `code-tabs` directive: + +```rst +.. tabs:: + + .. code-tab:: c I love C + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py I love Python more + + def main(): + return + +``` + +The tab label is used to group tabs, including `code-tabs`. As such, the same custom label should be used to group related tabs. + +[github-ci]: https://github.com/executablebooks/sphinx-tabs/workflows/continuous-integration/badge.svg?branch=master +[github-link]: https://github.com/executablebooks/sphinx-tabs +[pypi-badge]: https://img.shields.io/pypi/v/sphinx-tabs.svg +[pypi-link]: https://pypi.org/project/sphinx-tabs +[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-tabs/branch/master/graph/badge.svg +[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-tabs + + + + +%package -n python3-sphinx-tabs +Summary: Tabbed views for Sphinx +Provides: python-sphinx-tabs +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinx-tabs +# sphinx-tabs + +[![Github-CI][github-ci]][github-link] +[![Coverage Status][codecov-badge]][codecov-link] +[![PyPI][pypi-badge]][pypi-link] + +Create tabbed content in [Sphinx documentation](http://www.sphinx-doc.org) when building HTML. + +For example, see the [Raw] code of [docs/index.rst](docs/index.rst) which generates the following: + +A live demo can be found here: <https://sphinx-tabs.readthedocs.io> + + + +## Installation + +```bash +pip install sphinx-tabs +``` + +To enable the extension in Sphinx, add the following to your conf.py: + +```python +extensions = ['sphinx_tabs.tabs'] +``` + +If needed, there is a configuration option to allow additional builders to be considered compatible. For example, to add the `linkcheck` builder, add the following to your conf.py: + +```python +sphinx_tabs_valid_builders = ['linkcheck'] +``` + +If you are using [Read The Docs](https://readthedocs.org/) for building your documentation, the extension must be added as a requirement. Please add the following to `requirements.txt` at the root of the project: + +``` +sphinx-tabs +``` + +## Contributing + +We welcome all contributions! +See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details. + +The simplest way to run tests is to install [pre-commit](https://pre-commit.com/) for linting and [tox](https://tox.readthedocs.io) for unit tests and documentation build: + +```console +$ pre-commit run --all +``` + +```console +$ tox -p +``` + +## Basic Tabs + +Basic tabs can be coded as follows: + +```rst +.. tabs:: + + .. tab:: Apples + + Apples are green, or sometimes red. + + .. tab:: Pears + + Pears are green. + + .. tab:: Oranges + + Oranges are orange. +``` + + + +The contents of each tab can be displayed by clicking on the tab that you wish to show. Clicking on the tab that is currently open will hide the tab's content, leaving only the tab set labels visible. + +Alternatively, tab sets can be focused using :kbd:`Tab`. The :kbd:`Left Arrow` and :kbd:`Right Arrow` keys can then be used to navigate across the tab set and :kbd:`Enter` can be used to select a tab. + +## Grouped Tabs + +Tabs can be grouped, so that changing the current tab in one tabset changes the current tab in all other tabsets containing a tab with a matching label. +For example: + +```rst +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 + +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 +``` + + + +If permitted by the user's browser, the last selected group tab will be remembered when changing page. As such, if any tabsets on the next page contain a tab with the same label it will be selected. + + +## Code Tabs + +Grouped tabs containing code with syntax highlighting can be created as follows: + +```rst +.. tabs:: + + .. code-tab:: c + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: c++ + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py + + def main(): + return + + .. code-tab:: java + + class Main { + public static void main(String[] args) { + } + } + + .. code-tab:: julia + + function main() + end + + .. code-tab:: fortran + + PROGRAM main + END PROGRAM main +``` + + + +Code tabs also support custom lexers (added via sphinx `conf.py`). Pass the lexers alias as the first argument of `code-tab`. + +By default, code tabs are labelled with the language name, though a custom label can be provided as an optional second argument to the `code-tabs` directive: + +```rst +.. tabs:: + + .. code-tab:: c I love C + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py I love Python more + + def main(): + return + +``` + +The tab label is used to group tabs, including `code-tabs`. As such, the same custom label should be used to group related tabs. + +[github-ci]: https://github.com/executablebooks/sphinx-tabs/workflows/continuous-integration/badge.svg?branch=master +[github-link]: https://github.com/executablebooks/sphinx-tabs +[pypi-badge]: https://img.shields.io/pypi/v/sphinx-tabs.svg +[pypi-link]: https://pypi.org/project/sphinx-tabs +[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-tabs/branch/master/graph/badge.svg +[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-tabs + + + + +%package help +Summary: Development documents and examples for sphinx-tabs +Provides: python3-sphinx-tabs-doc +%description help +# sphinx-tabs + +[![Github-CI][github-ci]][github-link] +[![Coverage Status][codecov-badge]][codecov-link] +[![PyPI][pypi-badge]][pypi-link] + +Create tabbed content in [Sphinx documentation](http://www.sphinx-doc.org) when building HTML. + +For example, see the [Raw] code of [docs/index.rst](docs/index.rst) which generates the following: + +A live demo can be found here: <https://sphinx-tabs.readthedocs.io> + + + +## Installation + +```bash +pip install sphinx-tabs +``` + +To enable the extension in Sphinx, add the following to your conf.py: + +```python +extensions = ['sphinx_tabs.tabs'] +``` + +If needed, there is a configuration option to allow additional builders to be considered compatible. For example, to add the `linkcheck` builder, add the following to your conf.py: + +```python +sphinx_tabs_valid_builders = ['linkcheck'] +``` + +If you are using [Read The Docs](https://readthedocs.org/) for building your documentation, the extension must be added as a requirement. Please add the following to `requirements.txt` at the root of the project: + +``` +sphinx-tabs +``` + +## Contributing + +We welcome all contributions! +See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details. + +The simplest way to run tests is to install [pre-commit](https://pre-commit.com/) for linting and [tox](https://tox.readthedocs.io) for unit tests and documentation build: + +```console +$ pre-commit run --all +``` + +```console +$ tox -p +``` + +## Basic Tabs + +Basic tabs can be coded as follows: + +```rst +.. tabs:: + + .. tab:: Apples + + Apples are green, or sometimes red. + + .. tab:: Pears + + Pears are green. + + .. tab:: Oranges + + Oranges are orange. +``` + + + +The contents of each tab can be displayed by clicking on the tab that you wish to show. Clicking on the tab that is currently open will hide the tab's content, leaving only the tab set labels visible. + +Alternatively, tab sets can be focused using :kbd:`Tab`. The :kbd:`Left Arrow` and :kbd:`Right Arrow` keys can then be used to navigate across the tab set and :kbd:`Enter` can be used to select a tab. + +## Grouped Tabs + +Tabs can be grouped, so that changing the current tab in one tabset changes the current tab in all other tabsets containing a tab with a matching label. +For example: + +```rst +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 + +.. tabs:: + + .. group-tab:: Linux + + Linux Line 1 + + .. group-tab:: Mac OSX + + Mac OSX Line 1 + + .. group-tab:: Windows + + Windows Line 1 +``` + + + +If permitted by the user's browser, the last selected group tab will be remembered when changing page. As such, if any tabsets on the next page contain a tab with the same label it will be selected. + + +## Code Tabs + +Grouped tabs containing code with syntax highlighting can be created as follows: + +```rst +.. tabs:: + + .. code-tab:: c + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: c++ + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py + + def main(): + return + + .. code-tab:: java + + class Main { + public static void main(String[] args) { + } + } + + .. code-tab:: julia + + function main() + end + + .. code-tab:: fortran + + PROGRAM main + END PROGRAM main +``` + + + +Code tabs also support custom lexers (added via sphinx `conf.py`). Pass the lexers alias as the first argument of `code-tab`. + +By default, code tabs are labelled with the language name, though a custom label can be provided as an optional second argument to the `code-tabs` directive: + +```rst +.. tabs:: + + .. code-tab:: c I love C + + int main(const int argc, const char **argv) { + return 0; + } + + .. code-tab:: py I love Python more + + def main(): + return + +``` + +The tab label is used to group tabs, including `code-tabs`. As such, the same custom label should be used to group related tabs. + +[github-ci]: https://github.com/executablebooks/sphinx-tabs/workflows/continuous-integration/badge.svg?branch=master +[github-link]: https://github.com/executablebooks/sphinx-tabs +[pypi-badge]: https://img.shields.io/pypi/v/sphinx-tabs.svg +[pypi-link]: https://pypi.org/project/sphinx-tabs +[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-tabs/branch/master/graph/badge.svg +[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-tabs + + + + +%prep +%autosetup -n sphinx-tabs-3.4.1 + +%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-sphinx-tabs -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 3.4.1-1 +- Package Spec generated @@ -0,0 +1 @@ +d06fe3a74cba52bba224ca7947164a32 sphinx-tabs-3.4.1.tar.gz |