diff options
Diffstat (limited to 'python-sphinx-airflow-theme.spec')
| -rw-r--r-- | python-sphinx-airflow-theme.spec | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/python-sphinx-airflow-theme.spec b/python-sphinx-airflow-theme.spec new file mode 100644 index 0000000..38ad9d1 --- /dev/null +++ b/python-sphinx-airflow-theme.spec @@ -0,0 +1,238 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinx-airflow-theme +Version: 0.0.11 +Release: 1 +Summary: Airflow theme for Sphinx +License: Apache License 2.0 +URL: https://github.com/apache/airflow-site/tree/aip-11 +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/af/9c/e24597907ee651f294f7f63c24d232323aa554e526a16e9b8736036dfb26/sphinx_airflow_theme-0.0.11.tar.gz +BuildArch: noarch + +Requires: python3-sphinx + +%description +Sphinx theme for Apache Airflow documentation. +# Install from sources +In order to start working with the theme, please follow the instructions below. +1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment: + ``` + mkvirtualenv -p python3 <name_of_environment> + ``` +2. To make Javascript and CSS code available for the theme, run the following command in the root directory: + ```shell script + ./site.sh build-site && ./site.sh prepare-theme + ``` +3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run: + ```shell script + pip install -e . + ``` +4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run: + ```shell script + ./docs.sh build && ./docs.sh preview + ``` +# Install developer version +To install the latest development version of a theme, run: +```shell script +THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)" +pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl" +``` +Python packages for your PRs is available as downloadable artifact in GitHub Actions after +the CI builds your PR. +# Configuration +A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`: +## `navbar_links` +The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed. +**Example values:** +```python +html_theme_options = { + 'navbar_links': [ + {'href': '/docs/', 'text': 'Documentation'} + ] +} +``` +(This is the default) +## `hide_website_buttons` +If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden. +**Example values:** +```python +html_theme_options = { + 'hide_website_buttons': False, +} +``` +## `sidebar_collapse` +## `sidebar_includehidden` +Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info +# Theme's source files + - `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files + - `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files + - `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it + in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js + +%package -n python3-sphinx-airflow-theme +Summary: Airflow theme for Sphinx +Provides: python-sphinx-airflow-theme +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinx-airflow-theme +Sphinx theme for Apache Airflow documentation. +# Install from sources +In order to start working with the theme, please follow the instructions below. +1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment: + ``` + mkvirtualenv -p python3 <name_of_environment> + ``` +2. To make Javascript and CSS code available for the theme, run the following command in the root directory: + ```shell script + ./site.sh build-site && ./site.sh prepare-theme + ``` +3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run: + ```shell script + pip install -e . + ``` +4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run: + ```shell script + ./docs.sh build && ./docs.sh preview + ``` +# Install developer version +To install the latest development version of a theme, run: +```shell script +THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)" +pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl" +``` +Python packages for your PRs is available as downloadable artifact in GitHub Actions after +the CI builds your PR. +# Configuration +A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`: +## `navbar_links` +The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed. +**Example values:** +```python +html_theme_options = { + 'navbar_links': [ + {'href': '/docs/', 'text': 'Documentation'} + ] +} +``` +(This is the default) +## `hide_website_buttons` +If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden. +**Example values:** +```python +html_theme_options = { + 'hide_website_buttons': False, +} +``` +## `sidebar_collapse` +## `sidebar_includehidden` +Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info +# Theme's source files + - `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files + - `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files + - `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it + in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js + +%package help +Summary: Development documents and examples for sphinx-airflow-theme +Provides: python3-sphinx-airflow-theme-doc +%description help +Sphinx theme for Apache Airflow documentation. +# Install from sources +In order to start working with the theme, please follow the instructions below. +1. Make sure your `python` shell command executes Python3 interpreter. If necessary, use a virtual environment: + ``` + mkvirtualenv -p python3 <name_of_environment> + ``` +2. To make Javascript and CSS code available for the theme, run the following command in the root directory: + ```shell script + ./site.sh build-site && ./site.sh prepare-theme + ``` +3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run: + ```shell script + pip install -e . + ``` +4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run: + ```shell script + ./docs.sh build && ./docs.sh preview + ``` +# Install developer version +To install the latest development version of a theme, run: +```shell script +THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)" +pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl" +``` +Python packages for your PRs is available as downloadable artifact in GitHub Actions after +the CI builds your PR. +# Configuration +A theme that supports the following configuration options under the `html_theme_options` dict in your projects `conf.py`: +## `navbar_links` +The list of links that should be available in the navigation bar at the top of the pages. The order of items will not be changed. +**Example values:** +```python +html_theme_options = { + 'navbar_links': [ + {'href': '/docs/', 'text': 'Documentation'} + ] +} +``` +(This is the default) +## `hide_website_buttons` +If ``True``, all links on the same domain but not pointing to this theme's page (e.g. `/community/`) will be hidden. +**Example values:** +```python +html_theme_options = { + 'hide_website_buttons': False, +} +``` +## `sidebar_collapse` +## `sidebar_includehidden` +Controls the ToC display in the sidebar. See https://www.sphinx-doc.org/en/master/templating.html#toctree for more info +# Theme's source files + - `<ROOT DIRECTORY>/sphinx_airflow_theme/sphinx_airflow_theme` - HTML files + - `<ROOT DIRECTORY>/landing-pages/site/assets/scss` - SCSS files + - `<ROOT DIRECTORY>/landing-pages/src/js` - Javascript files. If you create a new JS file, **don't forget to include it + in** `<ROOT DIRECTORY>/landing-pages/src/docs-index.js + +%prep +%autosetup -n sphinx-airflow-theme-0.0.11 + +%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-airflow-theme -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.11-1 +- Package Spec generated |