From bb695a8fc2602a020cca6ef1425595b6e903befc Mon Sep 17 00:00:00 2001 From: Kazuya Takei Date: Thu, 26 Oct 2023 01:26:41 +0900 Subject: [PATCH] refactor: Add deprecated notes --- README.rst | 14 +--- docs/index.rst | 16 ++--- docs/locales/ja/LC_MESSAGES/changelogs.po | 82 ++++++++++++++++------- docs/locales/ja/LC_MESSAGES/index.po | 60 ++++++++++------- src/sphinx_sqlite3fts/__init__.py | 6 ++ 5 files changed, 107 insertions(+), 71 deletions(-) diff --git a/README.rst b/README.rst index cabf252..95fe489 100644 --- a/README.rst +++ b/README.rst @@ -4,18 +4,10 @@ sphinx-sqlite3fts Sphinx new search page using SQL.js and SQLite database included FTS extension. -.. image:: https://img.shields.io/pypi/v/sphinx-sqlite3fts.svg - :target: https://pypi.org/project/sphinx-sqlite3fts/ +.. note:: -.. image:: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml/badge.svg?branch=main - :alt: Run CI - :target: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml - -.. image:: https://readthedocs.org/projects/sphinx-sqlite3fts/badge/?version=latest - :target: https://sphinx-sqlite3fts.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - -.. note:: This is experimental library + This is migrated to `atsphinx-sqlite3fts `_, + and it stop manintenance. Overview ======== diff --git a/docs/index.rst b/docs/index.rst index 247035d..c60f0cd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,18 +2,12 @@ sphinx-sqlite3fts ================= -=============== ============================================================================================================ -PyPI .. image:: https://img.shields.io/pypi/v/sphinx-sqlite3fts.svg - :target: https://pypi.org/project/sphinx-sqlite3fts/ - :alt: Published stable -GitHub Actions .. image:: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml/badge.svg?branch=main - :target: https://github.com/attakei-lab/sphinx-sqlite3fts/actions/workflows/main.yml - :alt: Run CI Status -Read the Docs .. image:: https://readthedocs.org/projects/sphinx-sqlite3fts/badge/?version=latest - :target: https://sphinx-sqlite3fts.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status -=============== ============================================================================================================ +.. important:: + It stopped manintenance. + + If you want to use same features, use `atsphinx-sqlite3fts `_. + ``sphinx-sqlite3fts`` is sphinx extension to provide some components. * Full-text search database by FTS5 diff --git a/docs/locales/ja/LC_MESSAGES/changelogs.po b/docs/locales/ja/LC_MESSAGES/changelogs.po index d17edd5..3ddc9ef 100644 --- a/docs/locales/ja/LC_MESSAGES/changelogs.po +++ b/docs/locales/ja/LC_MESSAGES/changelogs.po @@ -9,14 +9,14 @@ msgid "" msgstr "" "Project-Id-Version: sphinx-sqlite3fts \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-11-27 22:53+0900\n" +"POT-Creation-Date: 2023-10-26 01:21+0900\n" "PO-Revision-Date: 2022-11-28 00:40+0900\n" "Last-Translator: Kazuya Takei \n" "Language-Team: Kazuya Takei \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.11.0\n" +"Generated-By: Babel 2.13.1\n" #: ../../changelogs.rst:3 msgid "Changelogs" @@ -27,7 +27,7 @@ msgid "Latest changes" msgstr "" #: ../../../CHANGES.rst:6 -msgid "next" +msgid "v0.1.1" msgstr "" #: ../../../CHANGES.rst @@ -35,82 +35,116 @@ msgid "date" msgstr "公開日" #: ../../../CHANGES.rst:8 -msgid "future" -msgstr "未定" +msgid "2022-11-28" +msgstr "" + +#: ../../../CHANGES.rst:10 +msgid "Small bug-fixes." +msgstr "" + +#: ../../../CHANGES.rst:13 +msgid "Fixes" +msgstr "" + +#: ../../../CHANGES.rst:15 +msgid "Force override ``searchindex.js`` as blank file." +msgstr "" -#: ../../../CHANGES.rst:11 ../../../CHANGES.rst:50 +#: ../../../CHANGES.rst:16 +msgid "``searchtools.js`` initialize engine lazy." +msgstr "" + +#: ../../../CHANGES.rst:19 +msgid "v0.1.0" +msgstr "" + +#: ../../../CHANGES.rst:21 +msgid "2022-11-27" +msgstr "" + +#: ../../../CHANGES.rst:23 +msgid "For JavaScript based search-engine." +msgstr "" + +#: ../../../CHANGES.rst:26 ../../../CHANGES.rst:65 msgid "Features" msgstr "機能" -#: ../../../CHANGES.rst:13 +#: ../../../CHANGES.rst:28 msgid "Split sections from document for search (useful for refs of page)." msgstr "FTS上での管理単位をセクションに細分化する。（ページの参照構築用）" -#: ../../../CHANGES.rst:14 +#: ../../../CHANGES.rst:29 msgid "Add flag: search from database instead of Sphinx bundled search feature." msgstr "Sphinx組み込みの検索機能の代わりに、データベースからの検索を可能にする。" -#: ../../../CHANGES.rst:17 +#: ../../../CHANGES.rst:32 msgid "v0.0.3" msgstr "" -#: ../../../CHANGES.rst:19 +#: ../../../CHANGES.rst:34 msgid "2022-11-26" msgstr "" -#: ../../../CHANGES.rst:21 +#: ../../../CHANGES.rst:36 msgid "Update documents" msgstr "ドキュメントの更新" -#: ../../../CHANGES.rst:24 +#: ../../../CHANGES.rst:39 msgid "Documentation" msgstr "ドキュメント" -#: ../../../CHANGES.rst:26 +#: ../../../CHANGES.rst:41 msgid "Add badges into readme and documentation." msgstr "ドキュメントとREADMEへバッジを追加。" -#: ../../../CHANGES.rst:27 +#: ../../../CHANGES.rst:42 msgid "Follow notes for v0.0.2" msgstr "v0.0.2の変更履歴を追記。" -#: ../../../CHANGES.rst:30 +#: ../../../CHANGES.rst:45 msgid "v0.0.2" msgstr "" -#: ../../../CHANGES.rst:32 ../../../CHANGES.rst:45 +#: ../../../CHANGES.rst:47 ../../../CHANGES.rst:60 msgid "2022-11-23" msgstr "" -#: ../../../CHANGES.rst:34 +#: ../../../CHANGES.rst:49 msgid "Supporting for local development." msgstr "ローカル開発用の設定。" -#: ../../../CHANGES.rst:37 +#: ../../../CHANGES.rst:52 msgid "Miscellaneous" msgstr "その他" -#: ../../../CHANGES.rst:39 +#: ../../../CHANGES.rst:54 msgid "Use ``bump2version`` for release." msgstr "``bump2version`` を利用。" -#: ../../../CHANGES.rst:40 +#: ../../../CHANGES.rst:55 msgid "Configure about line-length for ``pycodestyle``." msgstr "``pycodestyle`` 向けの行設定（blackと同じ）" -#: ../../../CHANGES.rst:43 +#: ../../../CHANGES.rst:58 msgid "v0.0.1" msgstr "" -#: ../../../CHANGES.rst:47 +#: ../../../CHANGES.rst:62 msgid "This is first release." msgstr "最初のリリース。" -#: ../../../CHANGES.rst:52 +#: ../../../CHANGES.rst:67 msgid "Add ``sqlite`` builder that generate db.sqlite." msgstr "データベース作成のみを行う、 ``sqlite`` ビルダーを作成。" -#: ../../../CHANGES.rst:53 +#: ../../../CHANGES.rst:68 msgid "Inject generator for database into ``html`` based builder." msgstr "``html`` 系ビルダー向けに、データベース作成を行う処理を追加。" +#~ msgid "next" +#~ msgstr "" + +#~ msgid "future" +#~ msgstr "未定" + diff --git a/docs/locales/ja/LC_MESSAGES/index.po b/docs/locales/ja/LC_MESSAGES/index.po index 805874b..7fa0d0b 100644 --- a/docs/locales/ja/LC_MESSAGES/index.po +++ b/docs/locales/ja/LC_MESSAGES/index.po @@ -9,58 +9,68 @@ msgid "" msgstr "" "Project-Id-Version: sphinx-sqlite3fts \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-11-27 22:53+0900\n" +"POT-Creation-Date: 2023-10-26 01:22+0900\n" "PO-Revision-Date: 2022-11-28 00:40+0900\n" "Last-Translator: Kazuya Takei \n" "Language-Team: Kazuya Takei \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.11.0\n" +"Generated-By: Babel 2.13.1\n" #: ../../index.rst:3 msgid "sphinx-sqlite3fts" msgstr "" -#: ../../index.rst:6 -msgid "PyPI" -msgstr "" - -#: ../../index.rst -msgid "Published stable" +#: ../../index.rst:7 +msgid "It stopped manintenance." msgstr "" #: ../../index.rst:9 -msgid "GitHub Actions" -msgstr "" - -#: ../../index.rst -msgid "Run CI Status" -msgstr "" - -#: ../../index.rst:12 -msgid "Read the Docs" -msgstr "" - -#: ../../index.rst -msgid "Documentation Status" +msgid "" +"If you want to use same features, use `atsphinx-sqlite3fts " +"`_." msgstr "" -#: ../../index.rst:17 +#: ../../index.rst:11 msgid "``sphinx-sqlite3fts`` is sphinx extension to provide some components." msgstr "``sphinx-sqlite3fts`` は次のものを提供するSphinx拡張です。" -#: ../../index.rst:19 +#: ../../index.rst:13 msgid "Full-text search database by FTS5" msgstr "SQLite3+FTS5を用いた全文検索データベース" -#: ../../index.rst:20 +#: ../../index.rst:14 msgid "Custom HTML to search by user" msgstr "HTML向けのカスタム全文検索機能" -#: ../../index.rst:22 +#: ../../index.rst:16 msgid "" "This is experimental package. It implements minimum works and provide " "only minimum configurations." msgstr "これは、実験的なパッケージです。最小限の動作・設定のみで構成されています。" +#~ msgid "PyPI" +#~ msgstr "" + +#~ msgid "Published stable" +#~ msgstr "" + +#~ msgid "GitHub Actions" +#~ msgstr "" + +#~ msgid "Run CI Status" +#~ msgstr "" + +#~ msgid "Read the Docs" +#~ msgstr "" + +#~ msgid "Documentation Status" +#~ msgstr "" + +#~ msgid "" +#~ "This is migrated to `atsphinx-sqlite3fts" +#~ " `_, and it " +#~ "stop manintenance." +#~ msgstr "" + diff --git a/src/sphinx_sqlite3fts/__init__.py b/src/sphinx_sqlite3fts/__init__.py index 851b8b0..9ebd09b 100644 --- a/src/sphinx_sqlite3fts/__init__.py +++ b/src/sphinx_sqlite3fts/__init__.py @@ -1,13 +1,19 @@ """Sphinx document searcher using SQLite3.""" from sphinx.application import Sphinx +from sphinx.util import logging from . import builders, events __version__ = "0.1.1" +logger = logging.getLogger(__name__) + def setup(app: Sphinx): """Entrypoint as Sphinx extension.""" + logger.warning( + f"{__name__} is archived on {__version__}. Please use 'atsphinx-sqlite3fts'." + ) app.add_config_value("sqlite3fts_exclude_pages", [], "env") app.add_config_value("sqlite3fts_use_search_html", False, "env") app.add_builder(builders.SqliteBuilder)