openstack/xstatic-angular-material
Code Issues Proposed changes

Correct errors in README file

Browse Source 
This changes the README from a txt to rst file for output formatting
and corrects doc8 warnings causing package checks to fail.

Change-Id: I5e050c71429e40d294510bf1fd294218c4dae81f
This commit is contained in:
Sean McGinnis 2018-06-21 06:08:38 -05:00
parent 8f7db83c5c
commit 32f969a32a
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.txt → README.rst
View File

@ -1,7 +1,8 @@
XStatic-Angular-Material XStatic-Angular-Material
-------------- ------------------------
Angular-Material JavaScript and SCSS library packaged for setuptools (easy_install) / pip. Angular-Material JavaScript and SCSS library packaged for setuptools
(easy_install) / pip.
This package is intended to be used by **any** project that needs these files. This package is intended to be used by **any** project that needs these files.
@ -9,5 +10,6 @@ It intentionally does **not** provide any extra code except some metadata
**nor** has any extra requirements. You MAY use some minimal support code from **nor** has any extra requirements. You MAY use some minimal support code from
the XStatic base package, if you like. the XStatic base package, if you like.
You can find more info about the xstatic packaging way in the package `XStatic`. You can find more info about the xstatic packaging way in the package
`XStatic`.

2
setup.py
View File

@ -3,7 +3,7 @@ from xstatic.pkg import angular_material as xs
# The README.txt file should be written in reST so that PyPI can use # The README.txt file should be written in reST so that PyPI can use
# it to generate your project's PyPI page. # it to generate your project's PyPI page.
long_description = open('README.txt').read() long_description = open('README.rst').read()
setup( setup(
name=xs.PACKAGE_NAME, name=xs.PACKAGE_NAME,