docs: Add badges

attakei-lab · Nov 26, 2022 · a2187ba · a2187ba
1 parent e47737b
commit a2187ba
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -4,6 +4,17 @@ 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/
+
+.. 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
 
 Overview

diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,18 @@
 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
+=============== ============================================================================================================
+
 ``sphinx-sqlite3fts`` is sphinx extension to provide some components.
 
 * Full-text search database by FTS5

diff --git a/setup.cfg b/setup.cfg
@@ -7,5 +7,8 @@ message = release: Bump version {current_version} -> {new_version}
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"
 
+[doc8]
+ignore-path-errors=docs/index.rst;D001
+
 [pycodestyle]
 max-line-length = 88