Skip to content

Commit 07c8c84

Browse files
committed
Fix README rendering on PyPI
The rST parser used on PyPI rejects anything with warnings, which is why the rendering is broken for the current version: https://pypi.org/project/filelock/3.0.9/ This can be checked with: ``` $ pip install docutils pygments $ python setup.py check --metadata --restructuredtext running check warning: check: Duplicate implicit target name: "similar libraries". warning: check: Duplicate implicit target name: "installation". warning: check: Duplicate implicit target name: "documentation". warning: check: Duplicate implicit target name: "contributions". warning: check: Duplicate implicit target name: "license". ``` I fixed the warnings by removing the 'ToC' at the top. The README isn't so long so I don't think this is a huge loss. After this change, the check passes: ``` $ python setup.py check --metadata --restructuredtext running check ```
1 parent b71c3a4 commit 07c8c84

File tree

1 file changed

+0
-6
lines changed

1 file changed

+0
-6
lines changed

README.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ py-filelock
33

44
.. image:: https://travis-ci.org/benediktschmitt/py-filelock.svg?branch=master
55
:target: https://travis-ci.org/benediktschmitt/py-filelock
6-
7-
`Similar Libraries <#similar-libraries>`_
8-
~ `Installation <#installation>`_
9-
~ `Documentation <#documentation>`_
10-
~ `Contributions <#contributions>`_
11-
~ `License <#license>`_
126

137
This package contains a single module, which implements a platform independent
148
file lock in Python, which provides a simple way of inter-process communication:

0 commit comments

Comments
 (0)