Merge branch 'master' into patch-update-readme-001

miurahr · Jul 3, 2020 · fe53208 · fe53208
2 parents cf24c06 + 972f69b
commit fe53208
Show file tree

Hide file tree

Showing 7 changed files with 150 additions and 10 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,5 @@
 include *.rst
+include *.svg
 include *.toml
 include *.yml
 include LICENSE
@@ -11,6 +12,7 @@ recursive-include tests *.7z
 recursive-include tests *.0
 recursive-include docs *.bat
 recursive-include docs *.dot
+recursive-include docs *.png
 recursive-include docs *.py
 recursive-include docs *.rst
 recursive-include docs *.yml

diff --git a/README.rst b/README.rst
@@ -1,6 +1,11 @@
-=====
-py7zr
-=====
+======================================
+|logo| py7zr -- a 7z library on python
+======================================
+
+.. |logo| image:: logo.svg
+    :width: 80pt
+    :height: 80pt
+    :target: https://pypi.org/project/py7zr
 
 .. image:: https://readthedocs.org/projects/py7zr/badge/?version=latest
   :target: https://py7zr.readthedocs.io/en/latest/?badge=latest
@@ -21,11 +26,12 @@ py7zr
   :target: https://coveralls.io/github/miurahr/py7zr?branch=master
 
 
-Pure python 7-zip implementation
+
 
 py7zr is a library and utility to support 7zip archive compression, decompression,
 encryption and decryption written by Python programming language.
 
+
 Install
 =======
 
@@ -42,7 +48,6 @@ When you want to handle extra codecs (ZStandard) then add extra requirements to
     $ pip install py7zr[zstd]
 
 
-
 Documents
 =========
 

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -121,10 +121,16 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    # 'logo': 'logo.png',
+    'logo': 'logo.png',
+    'description': 'py7zr -- a 7z library',
+    'logo_name': True,
+    'github_banner': True,
     'github_user': 'miurahr',
     'github_repo': 'py7zr',
     'page_width': 'auto',
+    'badge_branch': 'master',
+    'donate_url': 'https://liberapay.com/miurahr',
+    'truvis_button': True,
 }
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
-==============================
-py7zr -- 7-zip archive library
-==============================
+===============================
+py7zr -- a 7z library on python
+===============================
 
 .. toctree::
    :maxdepth: 3

diff --git a/logo.svg b/logo.svg
diff --git a/setup.cfg b/setup.cfg
@@ -6,7 +6,7 @@ universal = 0
 
 [metadata]
 name = py7zr
-description = Pure python 7-zip decompression(restricted) library
+description = Pure python 7-zip library
 long_description = file: README.rst, Changelog.rst
 long_description_content_type = text/x-rst
 keywords = compression, 7zip, lzma, zstandard