diff options
Diffstat (limited to 'python-sphinx-rtd-dark-mode.spec')
| -rw-r--r-- | python-sphinx-rtd-dark-mode.spec | 259 |
1 files changed, 259 insertions, 0 deletions
diff --git a/python-sphinx-rtd-dark-mode.spec b/python-sphinx-rtd-dark-mode.spec new file mode 100644 index 0000000..2ffe0ca --- /dev/null +++ b/python-sphinx-rtd-dark-mode.spec @@ -0,0 +1,259 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinx-rtd-dark-mode +Version: 1.2.4 +Release: 1 +Summary: Dark mode for the Sphinx Read the Docs theme. +License: MIT +URL: https://github.com/MrDogeBro/sphinx_rtd_dark_mode +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/33/aa/a721ab63d83c8cfe2b37d8c744337713ee8858dabe6ff6f2b2593b25d010/sphinx_rtd_dark_mode-1.2.4.tar.gz +BuildArch: noarch + +Requires: python3-sphinx-rtd-theme + +%description +# Sphinx RTD Theme Dark Mode + +[](https://travis-ci.com/github/MrDogeBro/content_filter) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/main/LICENSE) [](http://makeapullrequest.com) + +This Sphinx extension adds a toggleable dark mode to the Read the Docs theme. +A little icon is added in the bottom right hand corner which allows the user +to switch between light or dark mode. + +## Installation + +**Python 3.4 or higher is required** + +To install dark mode for the RTD theme, enter the following command into your +terminal or command prompt. + +```bash +# Linux/OSX +python3 -m pip install sphinx-rtd-dark-mode + +# Windows +py -3 -m pip install sphinx-rtd-dark-mode +``` + +## Using the Extension + +To use the extension, you will need to add it to the extensions array in your config +file (`conf.py`). + +```py +extensions = ["sphinx_rtd_dark_mode"] +``` + +You will also need to be using the Sphinx RTD theme for this to work. If your not, +then the extension will change it for you as it only works for that theme. + +## Config + +Below are the options that are customizeable for the extension. Currently, there +is only one option available to configure. + +#### Default Dark Mode + +This lets you choose which theme the user sees when they load the docs for the first +time ever. After the first time however, this setting has no effect as the users +preference is stored in local storage within their browser. This option accepts a +boolean for the value. If this option is true (the default option), users will start +in dark mode when first visiting the site. If this option is false, users will start +in light mode when they first visit the site. + +```py +# user starts in dark mode +default_dark_mode = True + +# user starts in light mode +default_dark_mode = False +``` + +## License + +The Sphinx RTD Dark Mode module for Python is licensed under an [MIT license](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/master/LICENSE). + + + + +%package -n python3-sphinx-rtd-dark-mode +Summary: Dark mode for the Sphinx Read the Docs theme. +Provides: python-sphinx-rtd-dark-mode +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinx-rtd-dark-mode +# Sphinx RTD Theme Dark Mode + +[](https://travis-ci.com/github/MrDogeBro/content_filter) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/main/LICENSE) [](http://makeapullrequest.com) + +This Sphinx extension adds a toggleable dark mode to the Read the Docs theme. +A little icon is added in the bottom right hand corner which allows the user +to switch between light or dark mode. + +## Installation + +**Python 3.4 or higher is required** + +To install dark mode for the RTD theme, enter the following command into your +terminal or command prompt. + +```bash +# Linux/OSX +python3 -m pip install sphinx-rtd-dark-mode + +# Windows +py -3 -m pip install sphinx-rtd-dark-mode +``` + +## Using the Extension + +To use the extension, you will need to add it to the extensions array in your config +file (`conf.py`). + +```py +extensions = ["sphinx_rtd_dark_mode"] +``` + +You will also need to be using the Sphinx RTD theme for this to work. If your not, +then the extension will change it for you as it only works for that theme. + +## Config + +Below are the options that are customizeable for the extension. Currently, there +is only one option available to configure. + +#### Default Dark Mode + +This lets you choose which theme the user sees when they load the docs for the first +time ever. After the first time however, this setting has no effect as the users +preference is stored in local storage within their browser. This option accepts a +boolean for the value. If this option is true (the default option), users will start +in dark mode when first visiting the site. If this option is false, users will start +in light mode when they first visit the site. + +```py +# user starts in dark mode +default_dark_mode = True + +# user starts in light mode +default_dark_mode = False +``` + +## License + +The Sphinx RTD Dark Mode module for Python is licensed under an [MIT license](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/master/LICENSE). + + + + +%package help +Summary: Development documents and examples for sphinx-rtd-dark-mode +Provides: python3-sphinx-rtd-dark-mode-doc +%description help +# Sphinx RTD Theme Dark Mode + +[](https://travis-ci.com/github/MrDogeBro/content_filter) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/main/LICENSE) [](http://makeapullrequest.com) + +This Sphinx extension adds a toggleable dark mode to the Read the Docs theme. +A little icon is added in the bottom right hand corner which allows the user +to switch between light or dark mode. + +## Installation + +**Python 3.4 or higher is required** + +To install dark mode for the RTD theme, enter the following command into your +terminal or command prompt. + +```bash +# Linux/OSX +python3 -m pip install sphinx-rtd-dark-mode + +# Windows +py -3 -m pip install sphinx-rtd-dark-mode +``` + +## Using the Extension + +To use the extension, you will need to add it to the extensions array in your config +file (`conf.py`). + +```py +extensions = ["sphinx_rtd_dark_mode"] +``` + +You will also need to be using the Sphinx RTD theme for this to work. If your not, +then the extension will change it for you as it only works for that theme. + +## Config + +Below are the options that are customizeable for the extension. Currently, there +is only one option available to configure. + +#### Default Dark Mode + +This lets you choose which theme the user sees when they load the docs for the first +time ever. After the first time however, this setting has no effect as the users +preference is stored in local storage within their browser. This option accepts a +boolean for the value. If this option is true (the default option), users will start +in dark mode when first visiting the site. If this option is false, users will start +in light mode when they first visit the site. + +```py +# user starts in dark mode +default_dark_mode = True + +# user starts in light mode +default_dark_mode = False +``` + +## License + +The Sphinx RTD Dark Mode module for Python is licensed under an [MIT license](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/master/LICENSE). + + + + +%prep +%autosetup -n sphinx-rtd-dark-mode-1.2.4 + +%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-rtd-dark-mode -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.4-1 +- Package Spec generated |