Skip to content

Commit

Permalink
Make README compliant with PyPI RST renderer
Browse files Browse the repository at this point in the history
Signed-off-by: Oliwia Zaremba <oliwia.zaremba@zalando.de>
  • Loading branch information
tortila committed May 17, 2019
1 parent 2c5186f commit cd8ea2a
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 13 deletions.
10 changes: 1 addition & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -30,9 +25,6 @@
:alt: Code style: Black
:target: https://github.com/ambv/black

.. raw:: html

</div>

Transformer
***********
Expand Down
6 changes: 5 additions & 1 deletion common.mk
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ functest: configure
test: unittest functest

.PHONY: lint
lint: black flake8
lint: black flake8 check-readme

.PHONY: flake8
flake8: configure
Expand All @@ -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
43 changes: 40 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit cd8ea2a

Please sign in to comment.