summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCoprDistGit <infra@openeuler.org>2023-04-11 11:44:44 +0000
committerCoprDistGit <infra@openeuler.org>2023-04-11 11:44:44 +0000
commit4ab64a2154d882f912fa6cf2d177df13f52668bf (patch)
tree52fb3dd088053443fbd806771d8ef758b3af6bdb
parent6f8935f8e2de5c7f97d4a910f9150c6c69fb4396 (diff)
automatic import of python-sphinx-comments
-rw-r--r--.gitignore1
-rw-r--r--python-sphinx-comments.spec223
-rw-r--r--sources1
3 files changed, 225 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e69de29..b10fb26 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/sphinx-comments-0.0.3.tar.gz
diff --git a/python-sphinx-comments.spec b/python-sphinx-comments.spec
new file mode 100644
index 0000000..92948f4
--- /dev/null
+++ b/python-sphinx-comments.spec
@@ -0,0 +1,223 @@
+%global _empty_manifest_terminate_build 0
+Name: python-sphinx-comments
+Version: 0.0.3
+Release: 1
+Summary: Add comments and annotation to your documentation.
+License: MIT License
+URL: https://github.com/executablebooks/sphinx-comments
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c0/75/5bbf29e83eaf79843180cf424d0d550bda14a1792ca51dcf79daa065ba93/sphinx-comments-0.0.3.tar.gz
+BuildArch: noarch
+
+Requires: python3-sphinx
+Requires: python3-flake8
+Requires: python3-black
+Requires: python3-pre-commit
+Requires: python3-sphinx
+Requires: python3-sphinx-book-theme
+Requires: python3-myst-parser
+Requires: python3-beautifulsoup4
+Requires: python3-myst-parser
+Requires: python3-pytest
+Requires: python3-pytest-regressions
+Requires: python3-sphinx
+Requires: python3-sphinx-book-theme
+
+%description
+# Sphinx Comments
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-comments.svg)](https://pypi.org/project/sphinx_comments/) | [![Documentation](https://readthedocs.org/projects/sphinx-comments/badge/?version=latest)](https://sphinx-comments.readthedocs.io/en/latest/?badge=latest)
+
+Add comments and annotation functionality to your Sphinx website.
+
+Currently, these commenting engines are supported:
+
+- [Hypothes.is](https://hypothes.is/) provides a web overlay that allows you to annotate and comment collaboratively.
+- [utteranc.es](https://utteranc.es/) is a web commenting system that uses GitHub Issues to store and manage comments.
+- [`dokie.li`](https://dokie.li/) is an open source commenting and annotation overlay built on web standards.
+
+For examples of each service, as well as instructions for how to activate it,
+[see the `sphinx-comments` documentation](https://sphinx-comments.readthedocs.io/en/latest).
+
+## Contribute to Sphinx Comments
+
+Sphinx Comments follows [the Executable Books contributing guide](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md).
+
+### Install for development
+
+To install `sphinx-comments` for development, take the following steps:
+
+```bash
+git clone https://github.com/executablebooks/sphinx-comments
+cd sphinx-comments
+pip install -e .[testing,sphinx]
+```
+
+This will install the dependencies needed for development and testing.
+
+### Repository structure
+
+Sphinx Comments is a lightweight Sphinx extension that activates several Javascript libraries for use within Sphinx. All of its functionality is contained in `sphinx_comments/__init__.py`.
+
+As a general rule, Sphinx Comments tries to be as lightweight as possible. It simply:
+
+- Loads Javscript libraries for web commenting and annotation platforms
+- Provides a configuration layer for platforms that support it
+
+Note that some of these platforms cannot be activated at the same time, users
+will need to choose one or the other.
+
+Some of the annotation platforms require more complex setup - for example, `utteranc.es` requires its script to be placed in a specific location on the page, and so `sphinx-comments` will place it directly in the doctree of the page (underneath the content).
+
+
+
+
+%package -n python3-sphinx-comments
+Summary: Add comments and annotation to your documentation.
+Provides: python-sphinx-comments
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-sphinx-comments
+# Sphinx Comments
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-comments.svg)](https://pypi.org/project/sphinx_comments/) | [![Documentation](https://readthedocs.org/projects/sphinx-comments/badge/?version=latest)](https://sphinx-comments.readthedocs.io/en/latest/?badge=latest)
+
+Add comments and annotation functionality to your Sphinx website.
+
+Currently, these commenting engines are supported:
+
+- [Hypothes.is](https://hypothes.is/) provides a web overlay that allows you to annotate and comment collaboratively.
+- [utteranc.es](https://utteranc.es/) is a web commenting system that uses GitHub Issues to store and manage comments.
+- [`dokie.li`](https://dokie.li/) is an open source commenting and annotation overlay built on web standards.
+
+For examples of each service, as well as instructions for how to activate it,
+[see the `sphinx-comments` documentation](https://sphinx-comments.readthedocs.io/en/latest).
+
+## Contribute to Sphinx Comments
+
+Sphinx Comments follows [the Executable Books contributing guide](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md).
+
+### Install for development
+
+To install `sphinx-comments` for development, take the following steps:
+
+```bash
+git clone https://github.com/executablebooks/sphinx-comments
+cd sphinx-comments
+pip install -e .[testing,sphinx]
+```
+
+This will install the dependencies needed for development and testing.
+
+### Repository structure
+
+Sphinx Comments is a lightweight Sphinx extension that activates several Javascript libraries for use within Sphinx. All of its functionality is contained in `sphinx_comments/__init__.py`.
+
+As a general rule, Sphinx Comments tries to be as lightweight as possible. It simply:
+
+- Loads Javscript libraries for web commenting and annotation platforms
+- Provides a configuration layer for platforms that support it
+
+Note that some of these platforms cannot be activated at the same time, users
+will need to choose one or the other.
+
+Some of the annotation platforms require more complex setup - for example, `utteranc.es` requires its script to be placed in a specific location on the page, and so `sphinx-comments` will place it directly in the doctree of the page (underneath the content).
+
+
+
+
+%package help
+Summary: Development documents and examples for sphinx-comments
+Provides: python3-sphinx-comments-doc
+%description help
+# Sphinx Comments
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-comments.svg)](https://pypi.org/project/sphinx_comments/) | [![Documentation](https://readthedocs.org/projects/sphinx-comments/badge/?version=latest)](https://sphinx-comments.readthedocs.io/en/latest/?badge=latest)
+
+Add comments and annotation functionality to your Sphinx website.
+
+Currently, these commenting engines are supported:
+
+- [Hypothes.is](https://hypothes.is/) provides a web overlay that allows you to annotate and comment collaboratively.
+- [utteranc.es](https://utteranc.es/) is a web commenting system that uses GitHub Issues to store and manage comments.
+- [`dokie.li`](https://dokie.li/) is an open source commenting and annotation overlay built on web standards.
+
+For examples of each service, as well as instructions for how to activate it,
+[see the `sphinx-comments` documentation](https://sphinx-comments.readthedocs.io/en/latest).
+
+## Contribute to Sphinx Comments
+
+Sphinx Comments follows [the Executable Books contributing guide](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md).
+
+### Install for development
+
+To install `sphinx-comments` for development, take the following steps:
+
+```bash
+git clone https://github.com/executablebooks/sphinx-comments
+cd sphinx-comments
+pip install -e .[testing,sphinx]
+```
+
+This will install the dependencies needed for development and testing.
+
+### Repository structure
+
+Sphinx Comments is a lightweight Sphinx extension that activates several Javascript libraries for use within Sphinx. All of its functionality is contained in `sphinx_comments/__init__.py`.
+
+As a general rule, Sphinx Comments tries to be as lightweight as possible. It simply:
+
+- Loads Javscript libraries for web commenting and annotation platforms
+- Provides a configuration layer for platforms that support it
+
+Note that some of these platforms cannot be activated at the same time, users
+will need to choose one or the other.
+
+Some of the annotation platforms require more complex setup - for example, `utteranc.es` requires its script to be placed in a specific location on the page, and so `sphinx-comments` will place it directly in the doctree of the page (underneath the content).
+
+
+
+
+%prep
+%autosetup -n sphinx-comments-0.0.3
+
+%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-comments -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.3-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..94249b3
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+61a30eaef740d402aa4147c2c662bc41 sphinx-comments-0.0.3.tar.gz