Edit docs config and added logo

kyzima-spb · Jun 7, 2022 · bdcf4ee · bdcf4ee
1 parent 0d567e5
commit bdcf4ee
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -10,6 +10,17 @@ Documentation is in Russian only, use a translator for other languages.
 
 See the usage example_ for more understanding.
 
+Development
+-----------
+
+Run mypy::
+
+    docker-compose exec -w /package -u 1000:1000 sphinx mypy
+
+Run pytest::
+
+    docker-compose exec -w /package -u 1000:1000 sphinx pytest
+
 .. |PyPI| image:: https://img.shields.io/pypi/v/flask-uploader.svg
    :target: https://pypi.org/project/flask-uploader/
    :alt: Latest Version

diff --git a/docs/_static/logo.svg b/docs/_static/logo.svg
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,12 +17,22 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Flask-Uploader'
-copyright = '2022, Kirill Vercetti'
-author = 'Kirill Vercetti'
+from datetime import date
+try:
+    from importlib.metadata import metadata
+except ImportError:
+    from importlib_metadata import metadata
+import flask_uploader
+
+
+meta_info = metadata(flask_uploader.__name__)
+
+project = meta_info['Name']
+copyright = '{}, {}'.format(date.today().year, meta_info['Author'])
+author = meta_info['Author']
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+release = flask_uploader.__version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -82,9 +92,9 @@
     'show_related': True,
     'show_relbar_top': False,
     'show_relbar_bottom': True,
-    # 'logo': 'logo.png',
+    'logo': 'logo.svg',
     'github_user': 'kyzima-spb',
-    'github_repo': 'flask-uploader',
+    'github_repo': meta_info['Name'].lower(),
     'github_button': True,
     'github_type': 'star',
     'github_banner': True,

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,8 @@ Flask-Uploader
 
 |DOWNLOADS| |DOWNLOADS_M| |DOWNLOADS_W|
 
+Document version: |version| |release|
+
 **Flask-Uploader** - загрузчик файлов для Flask с гибкой возможностью расширения.
 
 Быстрый старт

diff --git a/src/flask_uploader/__init__.py b/src/flask_uploader/__init__.py
@@ -1,4 +1,8 @@
 from __future__ import annotations
+try:
+    from importlib.metadata import version
+except ImportError:
+    from importlib_metadata import version
 import typing as t
 
 from flask import Blueprint, Flask
@@ -11,6 +15,7 @@
     'init_uploader',
     'Uploader',
 )
+__version__ = version(__package__)
 
 
 def init_uploader(app: Flask) -> None:

diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-0.1.dev80
+0.1.dev86