automatic import of python-sphinx-autobuild

3 files changed, 442 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..413c2a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/sphinx-autobuild-2021.3.14.tar.gz
diff --git a/python-sphinx-autobuild.spec b/python-sphinx-autobuild.spec
new file mode 100644
index 0000000..91e3c85
--- /dev/null
+++ b/python-sphinx-autobuild.spec
@@ -0,0 +1,440 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-sphinx-autobuild
+Version:	2021.3.14
+Release:	1
+Summary:	Rebuild Sphinx documentation on changes, with live-reload in the browser.
+License:	MIT
+URL:		https://github.com/executablebooks/sphinx-autobuild
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/df/a5/2ed1b81e398bc14533743be41bf0ceaa49d671675f131c4d9ce74897c9c1/sphinx-autobuild-2021.3.14.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-sphinx
+Requires:	python3-livereload
+Requires:	python3-colorama
+Requires:	python3-pytest
+Requires:	python3-pytest-cov
+
+%description
+# sphinx-autobuild
+
+Rebuild Sphinx documentation on changes, with live-reload in the browser.
+
+<p align="center">
+
+![preview screenshot](./docs/_static/demo.png)
+
+</p>
+
+## Installation
+
+sphinx-autobuild is available on [PyPI](https://pypi.org/p/sphinx-autobuild/). It can be installed using pip:
+
+```
+pip install sphinx-autobuild
+```
+
+## Usage
+
+To build a classical Sphinx documentation set, run:
+
+```
+sphinx-autobuild docs docs/_build/html
+```
+
+This will start a server at http://127.0.0.1:8000 and start watching for changes in the `docs/` directory. When a change is detected in `docs/`, the documentation is rebuilt and any open browser windows are reloaded automatically. `KeyboardInterrupt` (<kbd>ctrl</kbd>+<kbd>c</kbd>) will stop the server.
+
+## Command line options
+
+sphinx-autobuild accepts the same arguments as `sphinx-build` (these get passed to sphinx-build on each build). It also has a few additional options, which can seen by running `sphinx-autobuild --help`:
+
+```sh-session
+$ sphinx-autobuild --help
+usage: sphinx-autobuild [-h] [--port PORT] [--host HOST] [--re-ignore RE_IGNORE] [--ignore IGNORE] [--no-initial] [--open-browser]
+                        [--delay DELAY] [--watch DIR] [--pre-build COMMAND] [--version]
+                        sourcedir outdir [filenames [filenames ...]]
+
+positional arguments:
+  sourcedir             source directory
+  outdir                output directory for built documentation
+  filenames             specific files to rebuild on each run (default: None)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --port PORT           port to serve documentation on. 0 means find and use a free port (default: 8000)
+  --host HOST           hostname to serve documentation on (default: 127.0.0.1)
+  --re-ignore RE_IGNORE
+                        regular expression for files to ignore, when watching for changes (default: [])
+  --ignore IGNORE       glob expression for files to ignore, when watching for changes (default: [])
+  --no-initial          skip the initial build (default: False)
+  --open-browser        open the browser after building documentation (default: False)
+  --delay DELAY         how long to wait before opening the browser (default: 5)
+  --watch DIR           additional directories to watch (default: [])
+  --pre-build COMMAND   additional command(s) to run prior to building the documentation (default: [])
+  --version             show program's version number and exit
+
+sphinx's arguments:
+  The following arguments are forwarded as-is to Sphinx. Please look at `sphinx --help` for more information.
+    -b=builder, -a, -E, -d=path, -j=N, -c=path, -C, -D=setting=value, -t=tag, -A=name=value, -n, -v, -q, -Q, -w=file, -W, -T, -N, -P
+```
+
+### Using with Makefile
+
+> FYI: Sphinx is planning to [move away from using `Makefile`](https://github.com/sphinx-doc/sphinx/issues/5618#issuecomment-502415633).
+
+To use sphinx-autobuild with the Makefile generated by Sphinx, add the following to the end of the Makefile:
+
+```make
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+```
+
+`make livehtml` will now invoke sphinx-autobuild.
+
+> If you generated the `Makefile` with an older version of sphinx, this syntax might not work for you. Consider [updating to the newer `Makefile`](https://github.com/sphinx-doc/sphinx/blob/af62fa61e6cbd88d0798963211e73e5ba0d55e6d/sphinx/templates/quickstart/Makefile.new_t) structure.
+
+### Automatically opening the browser
+
+sphinx-autobuild can open the homepage of the generated documentation in your default browser. Passing `--open-browser` will enable this behaviour.
+
+### Automatically selecting a port
+
+sphinx-autobuild asks the operating system for a free port number and use that for its server. Passing `--port=0` will enable this behaviour.
+
+## Workflow suggestions
+
+### Working on a Sphinx HTML theme
+
+When working on a Sphinx HTML theme, add the source directory of the theme as a watch directory. It is also recommended to disable Sphinx's incremental builds by passing the `-a` option to sphinx-autobuild.
+
+```
+sphinx-autobuild -a docs docs/_build/html --watch path/to/theme
+```
+
+This results in slower builds, but it ensures that all pages are built from the same state of the HTML theme. It also works around a [known issue in Sphinx](#user-content-relevant-sphinx-bugs) which causes significant problems during theme development.
+
+### Working on multiple projects
+
+When working on multiple Sphinx documentation projects simultaneously, it is required to use different output directories for each project. It is also recommended to use `--port=0` and `--open-browser` to avoid needing to manually manage ports and opening browser windows (which can get tedious quickly).
+
+```
+sphinx-autobuild --port=0 --open-browser pikachu/docs pikachu/docs/_build/html &
+sphinx-autobuild --port=0 --open-browser magickarp/docs magickarp/docs/_build/html &
+```
+
+## Relevant Sphinx Bugs
+
+Sphinx does not [detect changes in non-document files in incremental mode](https://github.com/GaretJax/sphinx-autobuild/issues/34), like theme files, static files and source code used with autodoc.
+
+At the time of writing, the only known workaround is to instruct Sphinx to rebuild the relevant pages. This can be done by disabling incremental mode (with `-a`) or passing relevant `filenames` in addition to source and output directory in the CLI.
+
+## Acknowledgements
+
+This project stands on the shoulders of giants like [Sphinx], [LiveReload] and [python-livereload], without whom this project would not be possible.
+
+Many thanks to everyone who has [contributed code](https://github.com/GaretJax/sphinx-autobuild/graphs/contributors) as well as participated in [discussions on the issue tracker](https://github.com/GaretJax/sphinx-autobuild/issues). This project is better thanks to your contribution. :smile:
+
+[Sphinx]: https://sphinx-doc.org/
+[LiveReload]: https://livereload.com/
+[python-livereload]: https://github.com/lepture/python-livereload
+
+
+%package -n python3-sphinx-autobuild
+Summary:	Rebuild Sphinx documentation on changes, with live-reload in the browser.
+Provides:	python-sphinx-autobuild
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-sphinx-autobuild
+# sphinx-autobuild
+
+Rebuild Sphinx documentation on changes, with live-reload in the browser.
+
+<p align="center">
+
+![preview screenshot](./docs/_static/demo.png)
+
+</p>
+
+## Installation
+
+sphinx-autobuild is available on [PyPI](https://pypi.org/p/sphinx-autobuild/). It can be installed using pip:
+
+```
+pip install sphinx-autobuild
+```
+
+## Usage
+
+To build a classical Sphinx documentation set, run:
+
+```
+sphinx-autobuild docs docs/_build/html
+```
+
+This will start a server at http://127.0.0.1:8000 and start watching for changes in the `docs/` directory. When a change is detected in `docs/`, the documentation is rebuilt and any open browser windows are reloaded automatically. `KeyboardInterrupt` (<kbd>ctrl</kbd>+<kbd>c</kbd>) will stop the server.
+
+## Command line options
+
+sphinx-autobuild accepts the same arguments as `sphinx-build` (these get passed to sphinx-build on each build). It also has a few additional options, which can seen by running `sphinx-autobuild --help`:
+
+```sh-session
+$ sphinx-autobuild --help
+usage: sphinx-autobuild [-h] [--port PORT] [--host HOST] [--re-ignore RE_IGNORE] [--ignore IGNORE] [--no-initial] [--open-browser]
+                        [--delay DELAY] [--watch DIR] [--pre-build COMMAND] [--version]
+                        sourcedir outdir [filenames [filenames ...]]
+
+positional arguments:
+  sourcedir             source directory
+  outdir                output directory for built documentation
+  filenames             specific files to rebuild on each run (default: None)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --port PORT           port to serve documentation on. 0 means find and use a free port (default: 8000)
+  --host HOST           hostname to serve documentation on (default: 127.0.0.1)
+  --re-ignore RE_IGNORE
+                        regular expression for files to ignore, when watching for changes (default: [])
+  --ignore IGNORE       glob expression for files to ignore, when watching for changes (default: [])
+  --no-initial          skip the initial build (default: False)
+  --open-browser        open the browser after building documentation (default: False)
+  --delay DELAY         how long to wait before opening the browser (default: 5)
+  --watch DIR           additional directories to watch (default: [])
+  --pre-build COMMAND   additional command(s) to run prior to building the documentation (default: [])
+  --version             show program's version number and exit
+
+sphinx's arguments:
+  The following arguments are forwarded as-is to Sphinx. Please look at `sphinx --help` for more information.
+    -b=builder, -a, -E, -d=path, -j=N, -c=path, -C, -D=setting=value, -t=tag, -A=name=value, -n, -v, -q, -Q, -w=file, -W, -T, -N, -P
+```
+
+### Using with Makefile
+
+> FYI: Sphinx is planning to [move away from using `Makefile`](https://github.com/sphinx-doc/sphinx/issues/5618#issuecomment-502415633).
+
+To use sphinx-autobuild with the Makefile generated by Sphinx, add the following to the end of the Makefile:
+
+```make
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+```
+
+`make livehtml` will now invoke sphinx-autobuild.
+
+> If you generated the `Makefile` with an older version of sphinx, this syntax might not work for you. Consider [updating to the newer `Makefile`](https://github.com/sphinx-doc/sphinx/blob/af62fa61e6cbd88d0798963211e73e5ba0d55e6d/sphinx/templates/quickstart/Makefile.new_t) structure.
+
+### Automatically opening the browser
+
+sphinx-autobuild can open the homepage of the generated documentation in your default browser. Passing `--open-browser` will enable this behaviour.
+
+### Automatically selecting a port
+
+sphinx-autobuild asks the operating system for a free port number and use that for its server. Passing `--port=0` will enable this behaviour.
+
+## Workflow suggestions
+
+### Working on a Sphinx HTML theme
+
+When working on a Sphinx HTML theme, add the source directory of the theme as a watch directory. It is also recommended to disable Sphinx's incremental builds by passing the `-a` option to sphinx-autobuild.
+
+```
+sphinx-autobuild -a docs docs/_build/html --watch path/to/theme
+```
+
+This results in slower builds, but it ensures that all pages are built from the same state of the HTML theme. It also works around a [known issue in Sphinx](#user-content-relevant-sphinx-bugs) which causes significant problems during theme development.
+
+### Working on multiple projects
+
+When working on multiple Sphinx documentation projects simultaneously, it is required to use different output directories for each project. It is also recommended to use `--port=0` and `--open-browser` to avoid needing to manually manage ports and opening browser windows (which can get tedious quickly).
+
+```
+sphinx-autobuild --port=0 --open-browser pikachu/docs pikachu/docs/_build/html &
+sphinx-autobuild --port=0 --open-browser magickarp/docs magickarp/docs/_build/html &
+```
+
+## Relevant Sphinx Bugs
+
+Sphinx does not [detect changes in non-document files in incremental mode](https://github.com/GaretJax/sphinx-autobuild/issues/34), like theme files, static files and source code used with autodoc.
+
+At the time of writing, the only known workaround is to instruct Sphinx to rebuild the relevant pages. This can be done by disabling incremental mode (with `-a`) or passing relevant `filenames` in addition to source and output directory in the CLI.
+
+## Acknowledgements
+
+This project stands on the shoulders of giants like [Sphinx], [LiveReload] and [python-livereload], without whom this project would not be possible.
+
+Many thanks to everyone who has [contributed code](https://github.com/GaretJax/sphinx-autobuild/graphs/contributors) as well as participated in [discussions on the issue tracker](https://github.com/GaretJax/sphinx-autobuild/issues). This project is better thanks to your contribution. :smile:
+
+[Sphinx]: https://sphinx-doc.org/
+[LiveReload]: https://livereload.com/
+[python-livereload]: https://github.com/lepture/python-livereload
+
+
+%package help
+Summary:	Development documents and examples for sphinx-autobuild
+Provides:	python3-sphinx-autobuild-doc
+%description help
+# sphinx-autobuild
+
+Rebuild Sphinx documentation on changes, with live-reload in the browser.
+
+<p align="center">
+
+![preview screenshot](./docs/_static/demo.png)
+
+</p>
+
+## Installation
+
+sphinx-autobuild is available on [PyPI](https://pypi.org/p/sphinx-autobuild/). It can be installed using pip:
+
+```
+pip install sphinx-autobuild
+```
+
+## Usage
+
+To build a classical Sphinx documentation set, run:
+
+```
+sphinx-autobuild docs docs/_build/html
+```
+
+This will start a server at http://127.0.0.1:8000 and start watching for changes in the `docs/` directory. When a change is detected in `docs/`, the documentation is rebuilt and any open browser windows are reloaded automatically. `KeyboardInterrupt` (<kbd>ctrl</kbd>+<kbd>c</kbd>) will stop the server.
+
+## Command line options
+
+sphinx-autobuild accepts the same arguments as `sphinx-build` (these get passed to sphinx-build on each build). It also has a few additional options, which can seen by running `sphinx-autobuild --help`:
+
+```sh-session
+$ sphinx-autobuild --help
+usage: sphinx-autobuild [-h] [--port PORT] [--host HOST] [--re-ignore RE_IGNORE] [--ignore IGNORE] [--no-initial] [--open-browser]
+                        [--delay DELAY] [--watch DIR] [--pre-build COMMAND] [--version]
+                        sourcedir outdir [filenames [filenames ...]]
+
+positional arguments:
+  sourcedir             source directory
+  outdir                output directory for built documentation
+  filenames             specific files to rebuild on each run (default: None)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --port PORT           port to serve documentation on. 0 means find and use a free port (default: 8000)
+  --host HOST           hostname to serve documentation on (default: 127.0.0.1)
+  --re-ignore RE_IGNORE
+                        regular expression for files to ignore, when watching for changes (default: [])
+  --ignore IGNORE       glob expression for files to ignore, when watching for changes (default: [])
+  --no-initial          skip the initial build (default: False)
+  --open-browser        open the browser after building documentation (default: False)
+  --delay DELAY         how long to wait before opening the browser (default: 5)
+  --watch DIR           additional directories to watch (default: [])
+  --pre-build COMMAND   additional command(s) to run prior to building the documentation (default: [])
+  --version             show program's version number and exit
+
+sphinx's arguments:
+  The following arguments are forwarded as-is to Sphinx. Please look at `sphinx --help` for more information.
+    -b=builder, -a, -E, -d=path, -j=N, -c=path, -C, -D=setting=value, -t=tag, -A=name=value, -n, -v, -q, -Q, -w=file, -W, -T, -N, -P
+```
+
+### Using with Makefile
+
+> FYI: Sphinx is planning to [move away from using `Makefile`](https://github.com/sphinx-doc/sphinx/issues/5618#issuecomment-502415633).
+
+To use sphinx-autobuild with the Makefile generated by Sphinx, add the following to the end of the Makefile:
+
+```make
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+```
+
+`make livehtml` will now invoke sphinx-autobuild.
+
+> If you generated the `Makefile` with an older version of sphinx, this syntax might not work for you. Consider [updating to the newer `Makefile`](https://github.com/sphinx-doc/sphinx/blob/af62fa61e6cbd88d0798963211e73e5ba0d55e6d/sphinx/templates/quickstart/Makefile.new_t) structure.
+
+### Automatically opening the browser
+
+sphinx-autobuild can open the homepage of the generated documentation in your default browser. Passing `--open-browser` will enable this behaviour.
+
+### Automatically selecting a port
+
+sphinx-autobuild asks the operating system for a free port number and use that for its server. Passing `--port=0` will enable this behaviour.
+
+## Workflow suggestions
+
+### Working on a Sphinx HTML theme
+
+When working on a Sphinx HTML theme, add the source directory of the theme as a watch directory. It is also recommended to disable Sphinx's incremental builds by passing the `-a` option to sphinx-autobuild.
+
+```
+sphinx-autobuild -a docs docs/_build/html --watch path/to/theme
+```
+
+This results in slower builds, but it ensures that all pages are built from the same state of the HTML theme. It also works around a [known issue in Sphinx](#user-content-relevant-sphinx-bugs) which causes significant problems during theme development.
+
+### Working on multiple projects
+
+When working on multiple Sphinx documentation projects simultaneously, it is required to use different output directories for each project. It is also recommended to use `--port=0` and `--open-browser` to avoid needing to manually manage ports and opening browser windows (which can get tedious quickly).
+
+```
+sphinx-autobuild --port=0 --open-browser pikachu/docs pikachu/docs/_build/html &
+sphinx-autobuild --port=0 --open-browser magickarp/docs magickarp/docs/_build/html &
+```
+
+## Relevant Sphinx Bugs
+
+Sphinx does not [detect changes in non-document files in incremental mode](https://github.com/GaretJax/sphinx-autobuild/issues/34), like theme files, static files and source code used with autodoc.
+
+At the time of writing, the only known workaround is to instruct Sphinx to rebuild the relevant pages. This can be done by disabling incremental mode (with `-a`) or passing relevant `filenames` in addition to source and output directory in the CLI.
+
+## Acknowledgements
+
+This project stands on the shoulders of giants like [Sphinx], [LiveReload] and [python-livereload], without whom this project would not be possible.
+
+Many thanks to everyone who has [contributed code](https://github.com/GaretJax/sphinx-autobuild/graphs/contributors) as well as participated in [discussions on the issue tracker](https://github.com/GaretJax/sphinx-autobuild/issues). This project is better thanks to your contribution. :smile:
+
+[Sphinx]: https://sphinx-doc.org/
+[LiveReload]: https://livereload.com/
+[python-livereload]: https://github.com/lepture/python-livereload
+
+
+%prep
+%autosetup -n sphinx-autobuild-2021.3.14
+
+%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-autobuild -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2021.3.14-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..e1ccda8
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+6d94d37f8cdd5a5e2ed76e15cf6c0913  sphinx-autobuild-2021.3.14.tar.gz