Merge pull request #60 from zalando-incubator/fix-readme-rendering

Make README compliant with PyPI RST renderer
zalando-incubator · May 17, 2019 · fd56541 · fd56541
2 parents 506b314 + cd8ea2a
commit fd56541
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 13 deletions.
diff --git a/README.rst b/README.rst
@@ -1,14 +1,9 @@
-.. raw:: html
-
-   <div align="center">
 
 .. image:: docs/_static/transformer.png
    :alt: Transformer logo
    :align: center
 
-.. raw:: html
-
-   <br>
+|
 
 .. image:: https://travis-ci.org/zalando-incubator/Transformer.svg?branch=master
    :alt: travis-ci status badge
@@ -30,9 +25,6 @@
    :alt: Code style: Black
    :target: https://github.com/ambv/black
 
-.. raw:: html
-
-   </div>
 
 Transformer
 ***********

diff --git a/common.mk b/common.mk
@@ -25,7 +25,7 @@ functest: configure
 test: unittest functest
 
 .PHONY: lint
-lint: black flake8
+lint: black flake8 check-readme
 
 .PHONY: flake8
 flake8: configure
@@ -34,3 +34,7 @@ flake8: configure
 .PHONY: clean
 clean:
 	rm -rf .make .pytest_cache __pycache__ dist .hypothesis har_transformer.egg-info
+
+.PHONY: check-readme
+check-readme: configure
+	poetry run python -m readme_renderer README.rst -o /dev/null
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -53,6 +53,7 @@ flake8-bugbear = "^18.8"
 flake8-docstrings = "^1.3"
 flake8-tidy-imports = "^2.0"
 tomlkit = "^0.5.3"
+readme_renderer = "^24.0"
 
 [build-system]
 requires = ["poetry>=0.12"]